Changeset 60600 in vbox for trunk/src/VBox/ValidationKit/bootsectors

Timestamp:

Apr 20, 2016 1:16:20 PM (9 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

106741

Message:

bsk3it: doc updates

Location:

trunk/src/VBox/ValidationKit/bootsectors/bs3kit

Files:

• bs3kit-docs.c (modified) (2 diffs)
• bs3kit-template-header.h (modified) (1 diff)
• bs3kit.h (modified) (11 diffs)

trunk/src/VBox/ValidationKit/bootsectors/bs3kit/bs3kit-docs.c

@@ -27 +27 @@
 
 
-/** @page pg_bs3kit BS3Kit - Boot Sector 3 Kit
+/** @page pg_bs3kit BS3Kit - Boot Sector Kit \#3
  *
  * The BS3Kit is a framework for bare metal floppy/usb image tests.
@@ -47 +47 @@
  *
  *
+ * @sa grp_bs3kit, grp_bs3kit_tmpl, grp_bs3kit_cmn, grp_bs3kit_mode,
+ *     grp_bs3kit_system
  *
  * @section sec_calling_convention      Calling convention

trunk/src/VBox/ValidationKit/bootsectors/bs3kit/bs3kit-template-header.h

@@ -27 +27 @@
 #include "bs3kit.h"
 
-/** @defgroup grp_bs3kit_tmpl       BS3Kit Multi-Mode Code Templates
+/** @defgroup grp_bs3kit_tmpl       Multi-Mode Code Templates
  * @ingroup grp_bs3kit
  *

trunk/src/VBox/ValidationKit/bootsectors/bs3kit/bs3kit.h

@@ -50 +50 @@
 
 /** @def BS3_USE_ALT_16BIT_TEXT_SEG
- * @addtogroup grp_bs3kit
+ * @ingroup grp_bs3kit
  * Combines the BS3_USE_RM_TEXT_SEG,  BS3_USE_X0_TEXT_SEG, and
  * BS3_USE_X1_TEXT_SEG indicators into a single one.
@@ -61 +61 @@
 
 /** @def BS3_MODEL_FAR_CODE
- * @addtogroup grp_bs3kit
+ * @ingroup grp_bs3kit
  * Default compiler model indicates far code.
  */
@@ -102 +102 @@
 RT_C_DECLS_BEGIN
 
-/** @defgroup grp_bs3kit     BS3Kit
+/** @defgroup grp_bs3kit     BS3Kit - Boot Sector Kit \#3
+ *
+ * The BS3Kit is a framework for bare metal floppy/usb image tests,
+ * see the @ref pg_bs3kit "doc page" for more.
+ *
  * @{ */
 
@@ -715 +719 @@
 
 
-/** @defgroup grp_bs3kit_system System structures
+/** @defgroup grp_bs3kit_system System Structures
  * @{ */
 /** The GDT, indexed by BS3_SEL_XXX shifted by 3. */
@@ -1055 +1059 @@
 
 
-/** @defgroup bs3kit_cross_ptr  Cross context pointer type
+/** @defgroup bs3kit_cross_ptr  Cross Context Pointer Type
  *
  * The cross context pointer type is
@@ -1064 +1068 @@
  * Cross context pointer base type.
  */
-#pragma pack(4)
 typedef union BS3XPTR
 {
@@ -1083 +1086 @@
 #endif
 } BS3XPTR;
-#pragma pack()
+AssertCompileSize(BS3XPTR, 4);
 
 
@@ -2500 +2503 @@
 typedef BS3TESTMODEENTRY const *PCBS3TESTMODEENTRY;
 
-/** Produces a BS3TESTMODEENTRY initializer for common (c16,c32,c64) test
- *  functions. */
+/** @def BS3TESTMODEENTRY_CMN
+ * Produces a BS3TESTMODEENTRY initializer for common (c16,c32,c64) test
+ * functions. */
 #define BS3TESTMODEENTRY_CMN(a_szTest, a_BaseNm) \
     {   /*pszSubTest =*/ a_szTest, \
@@ -2528 +2532 @@
     }
 
-/** A set of standard protypes to go with #BS3TESTMODEENTRY_CMN. */
+/** @def BS3TESTMODE_PROTOTYPES_CMN
+ * A set of standard protypes to go with #BS3TESTMODEENTRY_CMN. */
 #define BS3TESTMODE_PROTOTYPES_CMN(a_BaseNm) \
     FNBS3TESTDOMODE BS3_FAR_CODE    RT_CONCAT(a_BaseNm, _c16); \
@@ -2534 +2539 @@
     FNBS3TESTDOMODE BS3_FAR_CODE    RT_CONCAT(a_BaseNm, _c64)
 
-/** Produces a BS3TESTMODEENTRY initializer for a full set of mode test
- *  functions. */
+/** @def BS3TESTMODEENTRY_MODE
+ * Produces a BS3TESTMODEENTRY initializer for a full set of mode test
+ * functions. */
 #define BS3TESTMODEENTRY_MODE(a_szTest, a_BaseNm) \
     {   /*pszSubTest =*/ a_szTest, \
@@ -2562 +2568 @@
     }
 
-/** A set of standard protypes to go with #BS3TESTMODEENTRY_MODE. */
+/** @def BS3TESTMODE_PROTOTYPES_MODE
+ * A set of standard protypes to go with #BS3TESTMODEENTRY_MODE. */
 #define BS3TESTMODE_PROTOTYPES_MODE(a_BaseNm) \
     FNBS3TESTDOMODE BS3_FAR_CODE RT_CONCAT(a_BaseNm, _rm); \