VirtualBox

Changeset 7170 in vbox


Ignore:
Timestamp:
Feb 27, 2008 1:20:01 PM (17 years ago)
Author:
vboxsync
svn:sync-xref-src-repo-rev:
28465
Message:

Doxygen fixes. (DOXYGEN -> DOXYGEN_RUNNING, ++)

Location:
trunk/include/iprt
Files:
13 edited

Legend:

Unmodified
Added
Removed

  • trunk/include/iprt/asm.h

    r7103 r7170  
    170170# pragma intrinsic(_ReturnAddress)
    171171# define ASMReturnAddress() _ReturnAddress()
    172 #elif defined(__GNUC__) || defined(__DOXYGEN__)
     172#elif defined(__GNUC__) || defined(DOXYGEN_RUNNING)
    173173# define ASMReturnAddress() __builtin_return_address(0)
    174174#else
    … …  
    24952495 * @param   u64New  The 64-bit value to assign to *pu64.
    24962496 * @param   u64Old  The value to compare with.
    2497  * @param   pu32Old     Pointer store the old value at.
     2497 * @param   pu64Old     Pointer store the old value at.
    24982498 */
    24992499#if RT_INLINE_ASM_EXTERNAL && !RT_INLINE_ASM_USES_INTRIN
    … …  
    33393339 *
    33403340 * @param   pi8     Pointer to the 8-bit variable to read.
    3341  * @param   u8      The 8-bit value to assign to *pu8.
     3341 * @param   i8      The 8-bit value to assign to *pi8.
    33423342 */
    33433343DECLINLINE(void) ASMAtomicWriteS8(volatile int8_t *pi8, int8_t i8)
    … …  
    33513351 *
    33523352 * @param   pi8     Pointer to the 8-bit variable to read.
    3353  * @param   u8      The 8-bit value to assign to *pu8.
     3353 * @param   i8      The 8-bit value to assign to *pi8.
    33543354 */
    33553355DECLINLINE(void) ASMAtomicUoWriteS8(volatile int8_t *pi8, int8_t i8)
    … …  
    33883388 *
    33893389 * @param   pi16    Pointer to the 16-bit variable to read.
    3390  * @param   u16     The 16-bit value to assign to *pu16.
     3390 * @param   i16     The 16-bit value to assign to *pi16.
    33913391 */
    33923392DECLINLINE(void) ASMAtomicWriteS16(volatile int16_t *pi16, int16_t i16)
    … …  
    34003400 *
    34013401 * @param   pi16    Pointer to the 16-bit variable to read.
    3402  * @param   u16     The 16-bit value to assign to *pu16.
     3402 * @param   i16     The 16-bit value to assign to *pi16.
    34033403 */
    34043404DECLINLINE(void) ASMAtomicUoWriteS16(volatile int16_t *pi16, int16_t i16)
    … …  
    34383438 *
    34393439 * @param   pi32    Pointer to the 32-bit variable to read.
    3440  * @param   u32     The 32-bit value to assign to *pu32.
     3440 * @param   i32     The 32-bit value to assign to *pi32.
    34413441 */
    34423442DECLINLINE(void) ASMAtomicWriteS32(volatile int32_t *pi32, int32_t i32)
    … …  
    34503450 *
    34513451 * @param   pi32    Pointer to the 32-bit variable to read.
    3452  * @param   u32     The 32-bit value to assign to *pu32.
     3452 * @param   i32     The 32-bit value to assign to *pi32.
    34533453 */
    34543454DECLINLINE(void) ASMAtomicUoWriteS32(volatile int32_t *pi32, int32_t i32)
    … …  
    34923492 *
    34933493 * @param   pi64    Pointer to the 64-bit variable.
    3494  * @param   u64     The 64-bit value to assign to *pu64.
     3494 * @param   i64     The 64-bit value to assign to *pi64.
    34953495 */
    34963496DECLINLINE(void) ASMAtomicWriteS64(volatile int64_t *pi64, int64_t i64)
    … …  
    35043504 *
    35053505 * @param   pi64    Pointer to the 64-bit variable.
    3506  * @param   u64     The 64-bit value to assign to *pu64.
     3506 * @param   i64     The 64-bit value to assign to *pi64.
    35073507 */
    35083508DECLINLINE(void) ASMAtomicUoWriteS64(volatile int64_t *pi64, int64_t i64)

  • trunk/include/iprt/assert.h

    r6824 r7170  
    8888#   define AssertBreakpoint()   do { if (RTAssertDoBreakpoint()) { __asm__ __volatile__ ("int3; jmp 1f; 1:"); } } while (0)
    8989#  endif
    90 # elif defined(_MSC_VER)
     90# elif defined(_MSC_VER) || defined(DOXYGEN_RUNNING)
    9191#  define AssertBreakpoint()    do { if (RTAssertDoBreakpoint()) { __debugbreak(); } } while (0)
    9292# else
    … …  
    643643#   define AssertLogRelBreakpoint()     do { RTAssertDoBreakpoint(); __asm__ __volatile__ ("int3; jmp 1f; 1:"); } while (0)
    644644#  endif
    645 # elif defined(_MSC_VER)
     645# elif defined(_MSC_VER) || defined(DOXYGEN_RUNNING)
    646646#  define AssertLogRelBreakpoint()      do { RTAssertDoBreakpoint(); __debugbreak(); } while (0)
    647647# else
    … …  
    993993#  define AssertReleaseBreakpoint()     do { RTAssertDoBreakpoint(); __asm__ __volatile__ ("int3; jmp 1f; 1:"); } while (0)
    994994# endif
    995 #elif defined(_MSC_VER)
     995#elif defined(_MSC_VER) || defined(DOXYGEN_RUNNING)
    996996# define AssertReleaseBreakpoint()      do { RTAssertDoBreakpoint(); __debugbreak(); } while (0)
    997997#else

  • trunk/include/iprt/cdefs.h

    r6216 r7170  
    6666 * Shut up DOXYGEN warnings and guide it properly thru the code.
    6767 */
    68 #ifdef  __DOXYGEN__
     68#ifdef  DOXYGEN_RUNNING
    6969#define __AMD64__
    7070#define __X86__
    … …  
    8080#define Breakpoint
    8181#define RT_NO_DEPRECATED_MACROS
    82 #define ARCH_BITS
     82/** @todo #define ARCH_BITS
    8383#define HC_ARCH_BITS
    8484#define R3_ARCH_BITS
    8585#define R0_ARCH_BITS
    86 #define GC_ARCH_BITS
    87 #endif /* __DOXYGEN__ */
     86#define GC_ARCH_BITS */
     87#endif /* DOXYGEN_RUNNING */
    8888
    8989/** @def RT_ARCH_X86

  • trunk/include/iprt/cpputils.h

    r6170 r7170  
    6666
    6767
    68 /** 
     68/**
    6969 * Extensions to the std namespace.
    7070 */
    … …  
    7575template <class> class auto_ref_ptr;
    7676
    77 /** 
     77/**
    7878 * Base class for objects willing to support smart reference counting using
    7979 * the auto_ref_ptr template.
    … …  
    131131public:
    132132
    133     /** 
     133    /**
    134134     * Creates a null instance that does not manage anything.
    135135     */
    136136    auto_ref_ptr() : m (NULL) {}
    137137
    138     /** 
     138    /**
    139139     * Creates an instance that starts managing the given pointer. The
    140140     * reference counter of the object pointed to by @a a is incremented by
    … …  
    145145    auto_ref_ptr (C* a) : m (a) { if (m) m->ref(); }
    146146
    147     /** 
     147    /**
    148148     * Creates an instance that starts managing a pointer managed by the given
    149149     * instance. The reference counter of the object managed by @a that is
    … …  
    155155
    156156    ~auto_ref_ptr() { do_unref(); }
    157    
    158     /** 
     157
     158    /**
    159159     * Assigns the given pointer to this instance and starts managing it. The
    160160     * reference counter of the object pointed to by @a a is incremented by
    … …  
    166166    auto_ref_ptr &operator= (C *a) { do_reref (a); return *this; }
    167167
    168     /** 
     168    /**
    169169     * Assigns a pointer managed by the given instance to this instance and
    170170     * starts managing it. The reference counter of the object managed by @a
    … …  
    172172     * previously managed by this instance is decremented by one.
    173173     *
    174      * @param a Pointer to assign.
     174     * @param that Instance which pointer to reference.
    175175     */
    176176    auto_ref_ptr &operator= (const auto_ref_ptr &that) { do_reref (that.m); return *this; }
    177177
    178     /** 
     178    /**
    179179     * Returns @c true if this instance is @c null and false otherwise.
    180180     */
    181181    bool is_null() const { return m == NULL; }
    182182
    183     /** 
     183    /**
    184184     * Dereferences the instance by returning the managed pointer.
    185185     * Asserts that the managed pointer is not @c NULL.
    … …  
    187187    C *operator-> () const { AssertMsg (m, ("Managed pointer is NULL!\n")); return m; }
    188188
    189     /** 
     189    /**
    190190     * Returns the managed pointer or @c NULL if this instance is @c null.
    191191     */
    192192    C *raw() const { return m; }
    193193
    194     /** 
     194    /**
    195195     * Compares this auto_ref_ptr instance with another instance and returns
    196196     * @c true if both instances manage the same or @c NULL pointer.
    … …  
    202202     * class which is not always possible. You may analyze pointed objects
    203203     * yourself if you need more precise comparison.
    204      * 
     204     *
    205205     * @param that Instance to compare this instance with.
    206206     */
    … …  
    234234};
    235235
    236 /** 
     236/**
    237237 * The exception_trap_base class is an abstract base class for all
    238238 * exception_trap template instantiations.
    … …  
    252252};
    253253
    254 /** 
     254/**
    255255 * The exception_trap template acts like a wrapper for the given exception
    256256 * class that stores a full copy of the exception and therefore allows to
    … …  
    275275
    276276    int safe_callback()
    277     {   
     277    {
    278278      try
    279279      {
    … …  
    304304    }
    305305 * @endcode
    306  * 
     306 *
    307307 * @param T Exception class to wrap.
    308308 */
    … …  
    318318};
    319319
    320 /** 
     320/**
    321321 * Convenience function that allocates a new exception_trap instance on the
    322322 * heap by automatically deducing the exception_trap template argument from
    … …  
    334334    }
    335335 * @endcode
    336  * 
     336 *
    337337 * @param aTrapped Exception to put to the allocated trap.
    338  * 
     338 *
    339339 * @return Allocated exception_trap object.
    340340 */
    … …  
    347347
    348348/**
    349  * Enhancement of std::auto_ptr <char> intended to take pointers to char
     349 * Enhancement of std::auto_ptr @<char@> intended to take pointers to char
    350350 * buffers allocated using new[].
    351351 *
    352  * This differs from std::auto_ptr <char> so that it overloads some methods to
     352 * This differs from std::auto_ptr @<char@> so that it overloads some methods to
    353353 * uses delete[] instead of delete to delete the owned data in order to
    354354 * conform to the C++ standard (and avoid valgrind complaints).
    355355 *
    356356 * Note that you should not use instances of this class where pointers or
    357  * references to objects of std::auto_ptr <char> are expeced. Despite the fact
     357 * references to objects of std::auto_ptr @<char@> are expeced. Despite the fact
    358358 * the classes are related, the base is not polymorphic (in particular,
    359359 * neither the destructor nor the reset() method are virtual). It means that when

  • trunk/include/iprt/log.h

    r6515 r7170  
    675675
    676676
    677 #ifdef __DOXYGEN__
     677#ifdef DOXYGEN_RUNNING
    678678# define LOG_DISABLED
    679679# define LOG_ENABLED
    … …  
    972972 */
    973973
    974 #ifdef __DOXYGEN__
     974#ifdef DOXYGEN_RUNNING
    975975# define LOG_TO_COM
    976976# define LOG_NO_COM
    … …  
    10171017 */
    10181018
    1019 #ifdef __DOXYGEN__
     1019#ifdef DOXYGEN_RUNNING
    10201020# define LOG_TO_BACKDOOR
    10211021# define LOG_NO_BACKDOOR

  • trunk/include/iprt/mem.h

    r5999 r7170  
    351351# define RTMemDupEx     RTMemEfDupEx
    352352#endif
    353 #ifdef __DOXYGEN__
     353#ifdef DOXYGEN_RUNNING
    354354# define RTMEM_WRAP_TO_EF_APIS
    355355#endif

  • trunk/include/iprt/path.h

    r5999 r7170  
    9292 *          However it might be insufficient on other platforms
    9393 *          and even on PC a UNC volume spec won't be detected this way.
    94  *          Use the RTPath<too be created>() instead.
     94 *          Use the RTPath@<too be created@>() instead.
    9595 *
    9696 * @returns true if it is and false if it isn't.
    … …  
    116116/**
    117117 * Checks if the path exists.
    118  * 
     118 *
    119119 * Symbolic links will all be attempted resolved.
    120  * 
     120 *
    121121 * @returns true if it exists and false if it doesn't.
    122122 * @param   pszPath     The path to check.
    … …  
    267267 * @param   pszPath2    Path to compare (must be an absolute path).
    268268 *
    269  * @returns < 0 if the first path less than the second path.
     269 * @returns @< 0 if the first path less than the second path.
    270270 * @returns 0 if the first path identical to the second path.
    271  * @returns > 0 if the first path greater than the second path.
     271 * @returns @> 0 if the first path greater than the second path.
    272272 */
    273273RTDECL(int) RTPathCompare(const char *pszPath1, const char *pszPath2);
    … …  
    323323 *
    324324 * Linux:    /usr/lib
    325  * Windows:  <program files directory>/<application>
     325 * Windows:  @<program files directory@>/@<application@>
    326326 * Old path: same as RTPathProgram()
    327327 *
    … …  
    336336 * example NLS files, module sources, ...
    337337 *
    338  * Linux:    /usr/shared/<application>
    339  * Windows:  <program files directory>/<application>
     338 * Linux:    /usr/shared/@<application@>
     339 * Windows:  @<program files directory@>/@<application@>
    340340 * Old path: same as RTPathProgram()
    341341 *
    … …  
    350350 * example modules which can be loaded at runtime.
    351351 *
    352  * Linux:    /usr/lib/<application>
    353  * Windows:  <program files directory>/<application>
     352 * Linux:    /usr/lib/@<application@>
     353 * Windows:  @<program files directory@>/@<application@>
    354354 * Old path: same as RTPathProgram()
    355355 *
    … …  
    363363 * Gets the directory for documentation.
    364364 *
    365  * Linux:    /usr/share/doc/<application>
    366  * Windows:  <program files directory>/<application>
     365 * Linux:    /usr/share/doc/@<application@>
     366 * Windows:  @<program files directory@>/@<application@>
    367367 * Old path: same as RTPathProgram()
    368368 *

  • trunk/include/iprt/rand.h

    r5999 r7170  
    4747/**
    4848 * Generate a 32-bit signed random number in the set [i32First..i32Last].
    49  * 
     49 *
    5050 * @returns The random number.
    5151 * @param   i32First    First number in the set.
    … …  
    5656/**
    5757 * Generate a 32-bit signed random number.
    58  * 
     58 *
    5959 * @returns The random number.
    6060 */
    … …  
    6363/**
    6464 * Generate a 32-bit unsigned random number in the set [u32First..u32Last].
    65  * 
     65 *
    6666 * @returns The random number.
    6767 * @param   u32First    First number in the set.
    … …  
    7272/**
    7373 * Generate a 32-bit unsigned random number.
    74  * 
     74 *
    7575 * @returns The random number.
    7676 */
    … …  
    7878
    7979/**
    80  * Generate a 32-bit signed random number in the set [i32First..i32Last].
    81  * 
     80 * Generate a 64-bit signed random number in the set [i64First..i64Last].
     81 *
    8282 * @returns The random number.
    83  * @param   i32First    First number in the set.
    84  * @param   i32Last     Last number in the set.
     83 * @param   i64First    First number in the set.
     84 * @param   i64Last     Last number in the set.
    8585 */
    8686RTDECL(int64_t) RTRandS64Ex(int64_t i64First, int64_t i64Last);
    … …  
    8888/**
    8989 * Generate a 64-bit signed random number.
    90  * 
     90 *
    9191 * @returns The random number.
    9292 */
    … …  
    9595/**
    9696 * Generate a 64-bit unsigned random number in the set [u64First..u64Last].
    97  * 
     97 *
    9898 * @returns The random number.
    9999 * @param   u64First    First number in the set.
    … …  
    104104/**
    105105 * Generate a 64-bit unsigned random number.
    106  * 
     106 *
    107107 * @returns The random number.
    108108 */

  • trunk/include/iprt/req.h

    r7133 r7170  
    156156 *
    157157 * @returns iprt status code.
    158  * @param   pReqQueue       The request queue.
     158 * @param   ppQueue         Where to store the request queue pointer.
    159159 */
    160160RTDECL(int) RTReqCreateQueue(PRTREQQUEUE *ppQueue);
    … …  
    165165 *
    166166 * @returns iprt status code.
    167  * @param   pReqQueue       The request queue.
     167 * @param   pQueue          The request queue.
    168168 */
    169169RTDECL(int) RTReqDestroyQueue(PRTREQQUEUE pQueue);
    … …  
    176176 * @returns VERR_TIMEOUT if cMillies was reached without the packet being added.
    177177 *
    178  * @param   pReqQueue       The request queue.
     178 * @param   pQueue          The request queue.
    179179 * @param   cMillies        Number of milliseconds to wait for a pending request.
    180180 *                          Use RT_INDEFINITE_WAIT to only wait till one is added.
    … …  
    195195 * @returns VERR_TIMEOUT if cMillies was reached without the packet being completed.
    196196 *
    197  * @param   pReqQueue       The request queue.
     197 * @param   pQueue          The request queue.
    198198 * @param   ppReq           Where to store the pointer to the request.
    199199 *                          This will be NULL or a valid request pointer not matter what happends.
    … …  
    221221 * @returns VERR_TIMEOUT if cMillies was reached without the packet being completed.
    222222 *
    223  * @param   pReqQueue       The request queue.
     223 * @param   pQueue          The request queue.
    224224 * @param   ppReq           Where to store the pointer to the request.
    225225 *                          This will be NULL or a valid request pointer not matter what happends.
    … …  
    247247 * @returns VERR_TIMEOUT if cMillies was reached without the packet being completed.
    248248 *
    249  * @param   pReqQueue       The request queue.
     249 * @param   pQueue          The request queue.
    250250 * @param   ppReq           Where to store the pointer to the request.
    251251 *                          This will be NULL or a valid request pointer not matter what happends, unless fFlags
    … …  
    275275 * @returns VERR_TIMEOUT if cMillies was reached without the packet being completed.
    276276 *
    277  * @param   pReqQueue       The request queue.
     277 * @param   pQueue          The request queue.
    278278 * @param   ppReq           Where to store the pointer to the request.
    279279 *                          This will be NULL or a valid request pointer not matter what happends, unless fFlags
    … …  
    286286 * @param   cArgs           Number of arguments following in the ellipsis.
    287287 *                          Not possible to pass 64-bit arguments!
    288  * @param   pvArgs          Pointer to function arguments.
     288 * @param   Args            Variable argument vector.
    289289 */
    290290RTDECL(int) RTReqCallV(PRTREQQUEUE pQueue, PRTREQ *ppReq, unsigned cMillies, unsigned fFlags, PFNRT pfnFunction, unsigned cArgs, va_list Args);
    … …  
    299299 * @returns iprt status code.
    300300 *
    301  * @param   pReqQueue       The request queue.
     301 * @param   pQueue          The request queue.
    302302 * @param   ppReq           Where to store the pointer to the allocated packet.
    303303 * @param   enmType         Package type.

  • trunk/include/iprt/spinlock.h

    r5999 r7170  
    9393 * What to assign to a RTSPINLOCKTMP at definition.
    9494 */
    95 #ifdef __DOXYGEN__
     95#ifdef DOXYGEN_RUNNING
    9696# define RTSPINLOCKTMP_INITIALIZER
    9797#endif

  • trunk/include/iprt/stdint.h

    r5999 r7170  
    4242#include <iprt/cdefs.h>
    4343
    44 #if !(defined(RT_OS_LINUX) && defined(__KERNEL__)) && !defined(_MSC_VER) && !defined(__IBMC__) && !defined(__IBMCPP__) && !defined(IPRT_NO_CRT)
     44#if !(defined(RT_OS_LINUX) && defined(__KERNEL__)) && !defined(_MSC_VER) && !defined(__IBMC__) && !defined(__IBMCPP__) && !defined(IPRT_NO_CRT) && !defined(DOXYGEN_RUNNING)
    4545# include <stdint.h>
    4646
    4747#else
    4848
    49 #if !(defined(RT_OS_LINUX) && defined(__KERNEL__)) || defined(IPRT_NO_CRT)
     49#if !(defined(RT_OS_LINUX) && defined(__KERNEL__)) || defined(IPRT_NO_CRT) || defined(DOXGEN_RUNNING)
    5050/* machine specific */
    5151typedef signed char         __int8_t;
    … …  
    122122#endif /* !linux kernel || no-crt */
    123123
    124 #ifndef _MSC_VER
     124#if !defined(_MSC_VER) || defined(DOXYGEN_RUNNING)
    125125#ifndef _INTPTR_T_DECLARED
     126/** Signed interger type capable of holding a pointer value, very useful for casting. */
    126127typedef __intptr_t              intptr_t;
     128/** Unsigned interger type capable of holding a pointer value, very useful for casting. */
    127129typedef __uintptr_t             uintptr_t;
    128130#define _INTPTR_T_DECLARED
    129131#endif
    130 #endif /* !_MSC_VER */
     132#endif /* !_MSC_VER || DOXYGEN_RUNNING */
    131133
    132134#if !defined(__cplusplus) || defined(__STDC_CONSTANT_MACROS)

  • trunk/include/iprt/string.h

    r6041 r7170  
    503503 * @param   pvArgFormat Argument to the format worker.
    504504 * @param   pszFormat   Format string pointer.
    505  * @param   args        Argument list.
    506  */
    507 RTDECL(size_t) RTStrFormatV(PFNRTSTROUTPUT pfnOutput, void *pvArgOutput, PFNSTRFORMAT pfnFormat, void *pvArgFormat, const char *pszFormat, va_list args);
     505 * @param   InArgs      Argument list.
     506 */
     507RTDECL(size_t) RTStrFormatV(PFNRTSTROUTPUT pfnOutput, void *pvArgOutput, PFNSTRFORMAT pfnFormat, void *pvArgFormat, const char *pszFormat, va_list InArgs);
    508508
    509509/**
    … …  
    10211021 * @param   uBase       The base of the representation used.
    10221022 *                      If the function will look for known prefixes before defaulting to 10.
    1023  * @param   pi64        Where to store the converted number. (optional)
     1023 * @param   pi8         Where to store the converted number. (optional)
    10241024 */
    10251025RTDECL(int) RTStrToInt8Full(const char *pszValue, unsigned uBase, int8_t *pi8);

  • trunk/include/iprt/uni.h

    r5999 r7170  
    3535 * Define RTUNI_USE_WCTYPE to not use the IPRT unicode data but the
    3636 * data which the C runtime library provides. */
    37 #ifdef __DOXYGEN__
     37#ifdef DOXYGEN_RUNNING
    3838# define RTUNI_USE_WCTYPE
    3939#endif
Note: See TracChangeset for help on using the changeset viewer.

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