VirtualBox

Changeset 64367 in vbox for trunk/src/VBox


Ignore:
Timestamp:
Oct 22, 2016 5:25:58 PM (8 years ago)
Author:
vboxsync
Message:

ValidationKit/Bs3Kit: Doxygen

Location:
trunk/src/VBox/ValidationKit/bootsectors/bs3kit
Files:
6 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/VBox/ValidationKit/bootsectors/bs3kit/bs3-cmn-PitIrqHandler.c

    r62471 r64367  
    11/* $Id$ */
    22/** @file
    3  * BS3Kit - The PIT IRQ Handler and associated data..
     3 * BS3Kit - The PIT IRQ Handler and associated data.
    44 */
    55

  • trunk/src/VBox/ValidationKit/bootsectors/bs3kit/bs3-cmn-RegCtxConvertToRingX.c

    r62471 r64367  
    7272 *
    7373 * @returns Adjusted protected mode selector.
    74  * @param   uSeg            The current selector value.
     74 * @param   uSel            The current selector value.
    7575 * @param   bRing           The target ring.
    7676 * @param   iReg            Register index.

  • trunk/src/VBox/ValidationKit/bootsectors/bs3kit/bs3-cmn-TestFailed.c

    r60527 r64367  
    3535
    3636/**
    37  * @impl_callback_method{FNBS3STRFORMATOUTPUT,
     37 * @callback_method_impl{FNBS3STRFORMATOUTPUT,
    3838 *      Used by Bs3TestFailedV and Bs3TestSkippedV.}
    3939 */

  • trunk/src/VBox/ValidationKit/bootsectors/bs3kit/bs3-cmn-TestPrintf.c

    r60527 r64367  
    5959
    6060/**
    61  * @impl_callback_method{FNBS3STRFORMATOUTPUT, Prints to screen and VMMDev}
     61 * @callback_method_impl{FNBS3STRFORMATOUTPUT, Prints to screen and VMMDev}
    6262 */
    6363static BS3_DECL_CALLBACK(size_t) bs3TestPrintfStrOutput(char ch, void BS3_FAR *pvUser)

  • trunk/src/VBox/ValidationKit/bootsectors/bs3kit/bs3-cmn-test.h

    r62484 r64367  
    138138
    139139/**
    140  * @impl_callback_method{FNBS3STRFORMATOUTPUT,
     140 * @callback_method_impl{FNBS3STRFORMATOUTPUT,
    141141 *      Used by Bs3TestFailedV and Bs3TestSkippedV.
    142142 *

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

    r62410 r64367  
    4545 * BS3_USE_X1_TEXT_SEG indicators into a single one.
    4646 */
    47 #if defined(BS3_USE_RM_TEXT_SEG) || defined(BS3_USE_X0_TEXT_SEG) || defined(BS3_USE_X1_TEXT_SEG)
     47#if defined(BS3_USE_RM_TEXT_SEG) || defined(BS3_USE_X0_TEXT_SEG) || defined(BS3_USE_X1_TEXT_SEG) || defined(DOXYGEN_RUNNING)
    4848# define BS3_USE_ALT_16BIT_TEXT_SEG
    4949#else
    … …  
    539539#endif
    540540
    541 /** @def BS3_MAKE_PROT_PTR_FROM_FLAT
     541/** @def BS3_MAKE_PROT_R0PTR_FROM_FLAT
    542542 * Creates a protected mode pointer from a flat address.
    543543 *
    … …  
    695695 *  \#define Bs3Gdt BS3_DATA_NM(Bs3Gdt)
    696696 *  extern X86DESC BS3_FAR_DATA Bs3Gdt
    697 f * @endcode
     697 * @endcode
    698698 *
    699699 * @param   a_Name      The name of the global variable.
    … …  
    707707
    708708/**
    709  * Template for createing a pointer union type.
     709 * Template for creating a pointer union type.
    710710 * @param   a_BaseName      The base type name.
    711  * @param   a_Modifier      The type modifier.
     711 * @param   a_Modifiers     The type modifier.
    712712 */
    713713#define BS3_PTR_UNION_TEMPLATE(a_BaseName, a_Modifiers) \
    … …  
    10101010extern X86XDTR64 BS3_FAR_DATA Bs3Lidt_Idt64;
    10111011/** Structure for the LIDT instruction for loading the real mode interrupt
    1012  *  vector table.. */
     1012 *  vector table. */
    10131013extern X86XDTR64 BS3_FAR_DATA Bs3Lidt_Ivt;
    10141014/** Structure for the LGDT instruction for loading the current GDT. */
    … …  
    11901190#endif
    11911191
    1192 /** @def BS3_XPTR_DEF_MEMBER
     1192/** @def BS3_XPTR_MEMBER
    11931193 * Defines a pointer member that can be shared by all CPU modes.
    11941194 *
    … …  
    11981198#define BS3_XPTR_MEMBER(a_Type, a_Name) BS3_XPTR_DEF_INTERNAL(RT_NOTHING, a_Type, a_Name)
    11991199
    1200 /** @def BS3_XPTR_DEF_AUTO
     1200/** @def BS3_XPTR_AUTO
    12011201 * Defines a pointer static variable for working with an XPTR.
    12021202 *
    … …  
    12091209#define BS3_XPTR_AUTO(a_Type, a_Name) BS3_XPTR_DEF_INTERNAL(RT_NOTHING, a_Type, a_Name)
    12101210
    1211 /** @def BS3_XPTR_SET
     1211/** @def BS3_XPTR_SET_FLAT
    12121212 * Sets a cross context pointer.
    12131213 *
    … …  
    13781378#endif
    13791379
    1380 /** @BS3_CMN_PROTO_STUB
     1380/** @def BS3_CMN_PROTO_STUB
    13811381 * Macro for prototyping all the variations of a common function with automatic
    13821382 * near -> far stub.
    … …  
    13891389#define BS3_CMN_PROTO_STUB(a_RetType, a_Name, a_Params) BS3_CMN_PROTO_INT(a_RetType, a_Name, a_Params)
    13901390
    1391 /** @BS3_CMN_PROTO_NOSB
     1391/** @def BS3_CMN_PROTO_NOSB
    13921392 * Macro for prototyping all the variations of a common function without any
    13931393 * near > far stub.
    … …  
    14001400#define BS3_CMN_PROTO_NOSB(a_RetType, a_Name, a_Params) BS3_CMN_PROTO_INT(a_RetType, a_Name, a_Params)
    14011401
    1402 /** @BS3_CMN_PROTO_FRST
     1402/** @def BS3_CMN_PROTO_FARSTUB
    14031403 * Macro for prototyping all the variations of a common function with automatic
    14041404 * far -> near stub.
    … …  
    14871487 * Formats and prints a string to the screen.
    14881488 *
    1489  * See #Bs3StrFormatV_c16 for supported format types.
     1489 * See #Bs3StrFormatV for supported format types.
    14901490 *
    14911491 * @param   pszFormat       The format string.
    … …  
    14971497 * Formats and prints a string to the screen, va_list version.
    14981498 *
    1499  * See #Bs3Format_c16 for supported format types.
     1499 * See #Bs3StrFormatV for supported format types.
    15001500 *
    15011501 * @param   pszFormat       The format string.
    … …  
    15141514 * Prints a string to the screen.
    15151515 *
    1516  * @param   pchString       The string to print.  Any terminator charss will be printed.
     1516 * @param   pszString       The string to print.  Any terminator charss will be printed.
    15171517 * @param   cchString       The exact number of characters to print.
    15181518 */
    … …  
    15641564 * Formats a string into a buffer.
    15651565 *
    1566  * See #Bs3Format_c16 for supported format types.
     1566 * See #Bs3StrFormatV for supported format types.
    15671567 *
    15681568 * @returns The length of the formatted string (excluding terminator).
    … …  
    15781578 * Formats a string into a buffer.
    15791579 *
    1580  * See #Bs3Format_c16 for supported format types.
     1580 * See #Bs3StrFormatV for supported format types.
    15811581 *
    15821582 * @returns The length of the formatted string (excluding terminator).
    … …  
    16241624 * @param   pvDst           The destination buffer.
    16251625 * @param   pvSrc           The source buffer.
    1626  * @param   cbCopy          The number of bytes to copy.
     1626 * @param   cbToCopy        The number of bytes to copy.
    16271627 */
    16281628BS3_CMN_PROTO_STUB(void BS3_FAR *, Bs3MemCpy,(void BS3_FAR *pvDst, const void BS3_FAR *pvSrc, size_t cbToCopy));
    … …  
    16341634 * @param   pvDst           The destination buffer.
    16351635 * @param   pvSrc           The source buffer.
    1636  * @param   cbCopy          The number of bytes to copy.
     1636 * @param   cbToCopy        The number of bytes to copy.
    16371637 */
    16381638BS3_CMN_PROTO_STUB(void BS3_FAR *, Bs3MemPCpy,(void BS3_FAR *pvDst, const void BS3_FAR *pvSrc, size_t cbToCopy));
    … …  
    16441644 * @param   pvDst           The destination buffer.
    16451645 * @param   pvSrc           The source buffer.
    1646  * @param   cbCopy          The number of bytes to copy.
     1646 * @param   cbToCopy        The number of bytes to copy.
    16471647 */
    16481648BS3_CMN_PROTO_STUB(void BS3_FAR *, Bs3MemMove,(void BS3_FAR *pvDst, const void BS3_FAR *pvSrc, size_t cbToCopy));
    … …  
    16811681 * @param   pv1             The left hand memory.
    16821682 * @param   pv2             The right hand memory.
    1683  * @param   bNeedle         The number of bytes to compare.
     1683 * @param   cb              The number of bytes to compare.
    16841684 */
    16851685BS3_CMN_PROTO_NOSB(int, Bs3MemCmp,(void const BS3_FAR *pv1, void const BS3_FAR *pv2, size_t cb));
    … …  
    26412641 *
    26422642 * @param   iIvt        The index of the IDT entry to set.
    2643  * @param   uSel        The handler real-mode segment.
     2643 * @param   uSeg        The handler real-mode segment.
    26442644 * @param   off         The handler offset.
    26452645 */
    … …  
    33343334/** @} */
    33353335
     3336/** @} */
     3337
    33363338RT_C_DECLS_END
    33373339
Note: See TracChangeset for help on using the changeset viewer.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette