VirtualBox

Changeset 81549 in vbox for trunk/include


Ignore:
Timestamp:
Oct 25, 2019 2:49:25 PM (5 years ago)
Author:
vboxsync
Message:

include/iprt/*.h: doxygen adjustments & fixes.

Location:
trunk/include/iprt
Files:
5 edited

Legend:

Unmodified
Added
Removed

  • trunk/include/iprt/cdefs.h

    r81403 r81549  
    6666# define IN_RING0
    6767# define IN_RING3
    68 # define IN_RC
    6968# define IN_RC
    7069# define IN_RT_RC
    … …  
    311310 */
    312311#if !defined(ARCH_BITS) || defined(DOXYGEN_RUNNING)
    313 # if defined(RT_ARCH_AMD64) || defined(RT_ARCH_SPARC64)
     312# if defined(RT_ARCH_AMD64) || defined(RT_ARCH_SPARC64) || defined(DOXYGEN_RUNNING)
    314313#  define ARCH_BITS 64
    315314# elif !defined(__I86__) || !defined(__WATCOMC__)
    … …  
    353352 */
    354353#if !defined(HC_ARCH_BITS) || defined(DOXYGEN_RUNNING)
    355 # ifndef IN_RC
     354# if !defined(IN_RC) || defined(DOXYGEN_RUNNING)
    356355#  define HC_ARCH_BITS ARCH_BITS
    357356# else
    … …  
    363362 * Defines the guest architecture bit count.
    364363 */
    365 #if !defined(GC_ARCH_BITS) && !defined(DOXYGEN_RUNNING)
    366 # ifdef VBOX_WITH_64_BITS_GUESTS
     364#if !defined(GC_ARCH_BITS) || defined(DOXYGEN_RUNNING)
     365# if defined(VBOX_WITH_64_BITS_GUESTS) || defined(DOXYGEN_RUNNING)
    367366#  define GC_ARCH_BITS  64
    368367# else
    … …  
    390389# else
    391390#  define R0_ARCH_BITS HC_ARCH_BITS
    392 # endif
    393 #endif
    394 
    395 /** @def GC_ARCH_BITS
    396  * Defines the guest architecture bit count.
    397  */
    398 #if !defined(GC_ARCH_BITS) || defined(DOXYGEN_RUNNING)
    399 # ifdef IN_RC
    400 #  define GC_ARCH_BITS ARCH_BITS
    401 # else
    402 #  define GC_ARCH_BITS 32
    403391# endif
    404392#endif
    … …  
    730718 * @remark  For pointers used only in one context use RCPTRTYPE(), R3R0PTRTYPE(), R3PTRTYPE() or R0PTRTYPE().
    731719 */
    732 #ifdef IN_RC
     720#if defined(IN_RC) && !defined(DOXYGEN_RUNNING)
    733721# define CTXTYPE(GCType, R3Type, R0Type)  GCType
    734 #elif defined(IN_RING3)
     722#elif defined(IN_RING3) || defined(DOXYGEN_RUNNING)
    735723# define CTXTYPE(GCType, R3Type, R0Type)  R3Type
    736724#else
    … …  
    798786 * @deprecated Use CTX_SUFF. Do NOT use this for new code.
    799787 */
    800 #ifdef IN_RC
     788#if defined(IN_RC) && !defined(DOXYGEN_RUNNING)
    801789# define CTXSUFF(var)       var##GC
    802790# define OTHERCTXSUFF(var)  var##HC
    … …  
    814802 * @deprecated Use CTX_SUFF. Do NOT use this for new code.
    815803 */
    816 #ifdef IN_RC
     804#if defined(IN_RC) && !defined(DOXYGEN_RUNNING)
    817805# define CTXALLSUFF(var)    var##GC
    818 #elif defined(IN_RING0)
     806#elif defined(IN_RING0) && !defined(DOXYGEN_RUNNING)
    819807# define CTXALLSUFF(var)    var##R0
    820808#else
    … …  
    831819 * @remark  This will replace CTXALLSUFF and CTXSUFF before long.
    832820 */
    833 #ifdef IN_RC
     821#if defined(IN_RC) && !defined(DOXYGEN_RUNNING)
    834822# define CTX_SUFF(var)      var##RC
    835 #elif defined(IN_RING0)
     823#elif defined(IN_RING0) && !defined(DOXYGEN_RUNNING)
    836824# define CTX_SUFF(var)      var##R0
    837825#else
    … …  
    849837 * @remark  This will replace CTXALLSUFF and CTXSUFF before long.
    850838 */
    851 #ifdef IN_RING3
     839#if defined(IN_RING3) || defined(DOXYGEN_RUNNING)
    852840# define CTX_SUFF_Z(var)    var##R3
    853841#else
    … …  
    873861 * @deprecated use CTX_MID or CTX_MID_Z
    874862 */
    875 #ifdef IN_RC
     863#if defined(IN_RC) && !defined(DOXYGEN_RUNNING)
    876864# define CTXMID(first, last)        first##GC##last
    877865# define OTHERCTXMID(first, last)   first##HC##last
    … …  
    890878 * @deprecated use CTX_MID or CTX_MID_Z
    891879 */
    892 #ifdef IN_RC
     880#if defined(IN_RC) && !defined(DOXYGEN_RUNNING)
    893881# define CTXALLMID(first, last)     first##GC##last
    894 #elif defined(IN_RING0)
     882#elif defined(IN_RING0) && !defined(DOXYGEN_RUNNING)
    895883# define CTXALLMID(first, last)     first##R0##last
    896884#else
    … …  
    906894 * @param   last    Surname.
    907895 */
    908 #ifdef IN_RC
     896#if defined(IN_RC) && !defined(DOXYGEN_RUNNING)
    909897# define CTX_MID(first, last)       first##RC##last
    910 #elif defined(IN_RING0)
     898#elif defined(IN_RING0) && !defined(DOXYGEN_RUNNING)
    911899# define CTX_MID(first, last)       first##R0##last
    912900#else
    … …  
    14181406 * @param   args    The argument list enclosed in parentheses.
    14191407 */
    1420 #ifdef IN_RING3
     1408#if defined(IN_RING3) || defined(DOXYGEN_RUNNING)
    14211409# define DECLR3CALLBACKMEMBER(type, name, args)  DECLCALLBACKMEMBER(type, name) args
    14221410#else
    … …  
    14301418 * @param   args    The argument list enclosed in parentheses.
    14311419 */
    1432 #ifdef IN_RC
     1420#if defined(IN_RC) || defined(DOXYGEN_RUNNING)
    14331421# define DECLRCCALLBACKMEMBER(type, name, args)  DECLCALLBACKMEMBER(type, name)  args
    14341422#else
    14351423# define DECLRCCALLBACKMEMBER(type, name, args)  RTRCPTR name
    14361424#endif
    1437 #ifdef IN_RC
     1425#if defined(IN_RC) || defined(DOXYGEN_RUNNING)
    14381426# define DECLRGCALLBACKMEMBER(type, name, args)  DECLCALLBACKMEMBER(type, name)  args
    14391427#else
    … …  
    14471435 * @param   args    The argument list enclosed in parentheses.
    14481436 */
    1449 #ifdef IN_RING0
     1437#if defined(IN_RING0) || defined(DOXYGEN_RUNNING)
    14501438# define DECLR0CALLBACKMEMBER(type, name, args)  DECLCALLBACKMEMBER(type, name) args
    14511439#else
    … …  
    14581446 * @remarks Don't use this macro on C++ methods.
    14591447 */
    1460 #ifdef __GNUC__
     1448#if defined(__GNUC__) && !defined(DOXYGEN_RUNNING)
    14611449# define DECLINLINE(type) static __inline__ type
    1462 #elif defined(__cplusplus)
     1450#elif defined(__cplusplus) || defined(DOXYGEN_RUNNING)
    14631451# define DECLINLINE(type) static inline type
    14641452#elif defined(_MSC_VER)

  • trunk/include/iprt/initterm.h

    r76585 r81549  
    5050
    5151#ifdef IN_RING3
     52
    5253/** @name RTR3Init flags (RTR3INIT_XXX).
    5354 * @{ */
    5455/** Try initialize SUPLib. */
    55 #define RTR3INIT_FLAGS_SUPLIB       RT_BIT(0)
     56# define RTR3INIT_FLAGS_SUPLIB       RT_BIT(0)
    5657/** Initializing IPRT from a DLL. */
    57 #define RTR3INIT_FLAGS_DLL          RT_BIT(1)
     58# define RTR3INIT_FLAGS_DLL          RT_BIT(1)
    5859/** We are sharing a process space, so we need to behave. */
    59 #define RTR3INIT_FLAGS_UNOBTRUSIVE  RT_BIT(2)
     60# define RTR3INIT_FLAGS_UNOBTRUSIVE  RT_BIT(2)
    6061/** The caller ensures that the argument bector is UTF-8. */
    61 #define RTR3INIT_FLAGS_UTF8_ARGV    RT_BIT(3)
     62# define RTR3INIT_FLAGS_UTF8_ARGV    RT_BIT(3)
    6263/** Indicates that this is a standalone application without any additional
    6364 * shared libraries in the application directory. Mainly windows loader mess. */
    64 #define RTR3INIT_FLAGS_STANDALONE_APP RT_BIT(4)
     65# define RTR3INIT_FLAGS_STANDALONE_APP RT_BIT(4)
    6566/** @} */
    6667
    … …  
    6869 * @{ */
    6970/** Version 1. */
    70 #define RTR3INIT_VER_1              UINT32_C(1)
     71# define RTR3INIT_VER_1              UINT32_C(1)
    7172/** The current version. */
    72 #define RTR3INIT_VER_CUR            RTR3INIT_VER_1
     73# define RTR3INIT_VER_CUR            RTR3INIT_VER_1
    7374/** @} */
    7475
    … …  
    132133 */
    133134RTR3DECL(bool) RTR3InitIsUnobtrusive(void);
     135
    134136#endif /* IN_RING3 */
    135137

  • trunk/include/iprt/log.h

    r81369 r81549  
    149149
    150150/** Logger structure. */
    151 #ifdef IN_RC
     151#if defined(IN_RC) && !defined(DOXYGEN_RUNNING)
    152152typedef struct RTLOGGERRC RTLOGGER;
    153153#else
    … …  
    294294
    295295
    296 #ifndef IN_RC
     296#if !defined(IN_RC) || defined(DOXYGEN_RUNNING)
    297297
    298298/** Pointer to internal logger bits. */
    … …  
    337337# define RTLOGGER_MAGIC     UINT32_C(0x19281207)
    338338
    339 #endif /* !IN_RC */
     339#endif /* !IN_RC || DOXYGEN_RUNNING */
    340340
    341341
    … …  
    17041704
    17051705
    1706 #ifndef IN_RC
     1706#if !defined(IN_RC) || defined(DOXYGEN_RUNNING)
    17071707/**
    17081708 * Sets the default release logger instance.
    … …  
    17121712 */
    17131713RTDECL(PRTLOGGER) RTLogRelSetDefaultInstance(PRTLOGGER pLogger);
    1714 #endif /* !IN_RC */
     1714#endif
    17151715
    17161716/**
    … …  
    19391939RTDECL(PRTLOGGER)   RTLogGetDefaultInstanceEx(uint32_t fFlagsAndGroup);
    19401940
    1941 #ifndef IN_RC
     1941#if !defined(IN_RC) || defined(DOXYGEN_RUNNING)
    19421942/**
    19431943 * Sets the default logger instance.
    … …  
    19471947 */
    19481948RTDECL(PRTLOGGER)   RTLogSetDefaultInstance(PRTLOGGER pLogger);
    1949 #endif /* !IN_RC */
     1949#endif
    19501950
    19511951#ifdef IN_RING0
    … …  
    19641964
    19651965
    1966 #ifndef IN_RC
     1966#if !defined(IN_RC) || defined(DOXYGEN_RUNNING)
     1967
    19671968/**
    19681969 * Creates the default logger instance for a iprt users.
    … …  
    22212222 */
    22222223RTDECL(int) RTLogGroupSettings(PRTLOGGER pLogger, const char *pszValue);
    2223 #endif /* !IN_RC */
     2224
     2225#endif /* !IN_RC || DOXYGEN_RUNNING */
    22242226
    22252227/**
    … …  
    22602262RTDECL(uint32_t) RTLogSetGroupLimit(PRTLOGGER pLogger, uint32_t cMaxEntriesPerGroup);
    22612263
    2262 #ifndef IN_RC
     2264#if !defined(IN_RC) || defined(DOXYGEN_RUNNING)
     2265
    22632266/**
    22642267 * Get the current log flags as a string.
    … …  
    22862289 * @returns IPRT status code.
    22872290 * @param   pLogger             Logger instance (NULL for default logger).
    2288  * @param   pszValue            The value to parse.
    22892291 * @param   pErrInfo            Where to return extended error info.  Optional.
    22902292 */
    … …  
    23012303 */
    23022304RTDECL(int) RTLogGetDestinations(PRTLOGGER pLogger, char *pszBuf, size_t cchBuf);
    2303 #endif /* !IN_RC */
     2305
     2306#endif /* !IN_RC || DOXYGEN_RUNNING */
    23042307
    23052308/**

  • trunk/include/iprt/thread.h

    r81531 r81549  
    280280                           RTTHREADTYPE enmType, unsigned fFlags, const char *pszName);
    281281#ifndef RT_OS_LINUX /* XXX crashes genksyms at least on 32-bit Linux hosts */
    282 /** @copydoc RTThreadCreate */
     282/** Pointer to a RTThreadCreate function. */
    283283typedef DECLCALLBACKPTR(int, PFNRTTHREADCREATE)(PRTTHREAD pThread, PFNRTTHREAD pfnThread, void *pvUser, size_t cbStack,
    284284                                                RTTHREADTYPE enmType, unsigned fFlags, const char *pszName);
    … …  
    298298 * @param   enmType     See RTThreadCreate.
    299299 * @param   fFlags      See RTThreadCreate.
    300  * @param   pszName     Thread name format.
     300 * @param   pszNameFmt  Thread name format.
    301301 * @param   va          Format arguments.
    302302 */
    … …  
    316316 * @param   enmType     See RTThreadCreate.
    317317 * @param   fFlags      See RTThreadCreate.
    318  * @param   pszName     Thread name format.
     318 * @param   pszNameFmt  Thread name format.
    319319 * @param   ...         Format arguments.
    320320 */
    … …  
    963963
    964964# endif /* IN_RING3 */
    965 # endif /* !IN_RC */
     965#endif /* !IN_RC || defined(DOXYGEN_RUNNING) */
    966966
    967967/** @} */

  • trunk/include/iprt/types.h

    r81369 r81549  
    15221522
    15231523/** HC pointer. */
    1524 #ifndef IN_RC
     1524#if !defined(IN_RC) || defined(DOXYGEN_RUNNING)
    15251525typedef void            RT_FAR *RTHCPTR;
    15261526#else
    … …  
    18451845/** @def NIL_RTRCPTR
    18461846 * NIL RC pointer.  */
    1847 #ifndef IN_RC
     1847#ifdef IN_RC
     1848# define NIL_RTRCPTR            (NULL)
     1849#else
    18481850# define NIL_RTRCPTR            ((RTRCPTR)0)
    1849 #else
    1850 # define NIL_RTRCPTR            (NULL)
    18511851#endif
    18521852/** @def RTRCPTR_MAX
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