VirtualBox

Changeset 81369 in vbox for trunk/include/iprt


Ignore:
Timestamp:
Oct 18, 2019 9:13:03 PM (5 years ago)
Author:
vboxsync
Message:

*: doxygen fixes

Location:
trunk/include/iprt
Files:
17 edited

Legend:

Unmodified
Added
Removed

  • trunk/include/iprt/asn1.h

    r76585 r81369  
    472472/** @name Helper macros for prototyping standard functions for an ASN.1 type.
    473473 * @{ */
     474
    474475#define RTASN1TYPE_STANDARD_PROTOTYPES_NO_GET_CORE(a_TypeNm, a_DeclMacro, a_ImplExtNm) \
    475476    a_DeclMacro(int)  RT_CONCAT(a_ImplExtNm,_Init)(RT_CONCAT(P,a_TypeNm) pThis, PCRTASN1ALLOCATORVTABLE pAllocator); \
    … …  
    486487
    487488
    488 /** @name Helper macros for prototyping standard functions for an ASN.1 type.
    489  * @{ */
    490489#define RTASN1TYPE_STANDARD_PROTOTYPES(a_TypeNm, a_DeclMacro, a_ImplExtNm, a_Asn1CoreNm) \
    491490    DECL_FORCE_INLINE(PRTASN1CORE) RT_CONCAT(a_ImplExtNm,_GetAsn1Core)(RT_CONCAT(PC,a_TypeNm) pThis) \
    … …  
    13781377    } while (0)
    13791378
    1380 /** Helpers for comparing optional context tags.
     1379/** @name Helpers for comparing optional context tags.
    13811380 * This will return if both are not present or if their precense differs.
    13821381 * @{ */

  • trunk/include/iprt/avl.h

    r76585 r81369  
    4141
    4242
    43 /** AVL tree of void pointers.
     43/** @name AVL tree of void pointers.
    4444 * @{
    4545 */
    … …  
    8686
    8787
    88 /** AVL tree of unsigned long.
     88/** @name AVL tree of unsigned long.
    8989 * @{
    9090 */
    … …  
    129129
    130130
    131 /** AVL tree of void pointer ranges.
     131/** @name AVL tree of void pointer ranges.
    132132 * @{
    133133 */
    … …  
    178178
    179179
    180 /** AVL tree of uint32_t
     180/** @name AVL tree of uint32_t
    181181 * @{
    182182 */
    … …  
    219219/** @} */
    220220
     221/** @name AVL tree of uint32_t, offset based
     222 * @{
     223 */
     224
    221225/**
    222226 * AVL uint32_t type for the relative offset pointer scheme.
    … …  
    267271
    268272
    269 /** AVL tree of uint32_t, list duplicates.
     273/** @name AVL tree of uint32_t, list duplicates.
    270274 * @{
    271275 */
    … …  
    306310
    307311
    308 /** AVL tree of uint64_t
     312/** @name AVL tree of uint64_t
    309313 * @{
    310314 */
    … …  
    348352
    349353
    350 /** AVL tree of uint64_t ranges.
     354/** @name AVL tree of uint64_t ranges.
    351355 * @{
    352356 */
    … …  
    397401
    398402
    399 /** AVL tree of RTGCPHYSes - using relative offsets internally.
     403/** @name AVL tree of RTGCPHYSes - using relative offsets internally.
    400404 * @{
    401405 */
    … …  
    449453
    450454
    451 /** AVL tree of RTGCPHYS ranges - using relative offsets internally.
     455/** @name AVL tree of RTGCPHYS ranges - using relative offsets internally.
    452456 * @{
    453457 */
    … …  
    507511
    508512
    509 /** AVL tree of RTGCPTRs.
     513/** @name AVL tree of RTGCPTRs.
    510514 * @{
    511515 */
    … …  
    548552
    549553
    550 /** AVL tree of RTGCPTRs - using relative offsets internally.
     554/** @name AVL tree of RTGCPTRs - using relative offsets internally.
    551555 * @{
    552556 */
    … …  
    599603
    600604
    601 /** AVL tree of RTGCPTR ranges.
     605/** @name AVL tree of RTGCPTR ranges.
    602606 * @{
    603607 */
    … …  
    650654
    651655
    652 /** AVL tree of RTGCPTR ranges - using relative offsets internally.
     656/** @name AVL tree of RTGCPTR ranges - using relative offsets internally.
    653657 * @{
    654658 */
    … …  
    707711
    708712
    709 /** AVL tree of RTGCPTR ranges (overlapping supported) - using relative offsets internally.
     713/** @name AVL tree of RTGCPTR ranges (overlapping supported) - using relative
     714 *        offsets internally.
    710715 * @{
    711716 */
    … …  
    766771
    767772
    768 /** AVL tree of RTUINTPTR.
     773/** @name AVL tree of RTUINTPTR.
    769774 * @{
    770775 */
    … …  
    815820
    816821
    817 /** AVL tree of RTUINTPTR ranges.
     822/** @name AVL tree of RTUINTPTR ranges.
    818823 * @{
    819824 */
    … …  
    868873
    869874
    870 /** AVL tree of RTHCPHYSes - using relative offsets internally.
     875/** @name AVL tree of RTHCPHYSes - using relative offsets internally.
    871876 * @{
    872877 */
    … …  
    922927
    923928
    924 /** AVL tree of RTIOPORTs - using relative offsets internally.
     929/** @name AVL tree of RTIOPORTs - using relative offsets internally.
    925930 * @{
    926931 */
    … …  
    972977
    973978
    974 /** AVL tree of RTIOPORT ranges - using relative offsets internally.
     979/** @name AVL tree of RTIOPORT ranges - using relative offsets internally.
    975980 * @{
    976981 */
    … …  
    10241029
    10251030
    1026 /** AVL tree of RTHCPHYSes.
     1031/** @name AVL tree of RTHCPHYSes.
    10271032 * @{
    10281033 */
    … …  
    10731078/** @} */
    10741079
    1075 /** AVL tree of RTGCPHYSes.
     1080/** @name AVL tree of RTGCPHYSes.
    10761081 * @{
    10771082 */
    … …  
    11231128
    11241129
    1125 /** AVL tree of RTFOFF ranges.
     1130/** @name AVL tree of RTFOFF ranges.
    11261131 * @{
    11271132 */

  • trunk/include/iprt/cdefs.h

    r80535 r81369  
    245245
    246246
    247 /** @def __X86__
     247/** @def \__X86__
    248248 * Indicates that we're compiling for the X86 architecture.
    249249 * @deprecated
    250250 */
    251251
    252 /** @def __AMD64__
     252/** @def \__AMD64__
    253253 * Indicates that we're compiling for the AMD64 architecture.
    254254 * @deprecated
    … …  
    37243724
    37253725
    3726 /** @def __PRETTY_FUNCTION__
     3726/** @def \__PRETTY_FUNCTION__
    37273727 *  With GNU C we'd like to use the builtin __PRETTY_FUNCTION__, so define that
    37283728 *  for the other compilers.

  • trunk/include/iprt/err.h

    r81062 r81369  
    12751275/** Found a ZIP64 Extra Information Field in a ZIP32 file. */
    12761276#define VERR_PKZIP_ZIP64EX_IN_ZIP32             (-965)
    1277 
     1277/** @} */
    12781278
    12791279/** @name RTZip status codes
    … …  
    21922192/** Negative exponent makes no sense to integer math. */
    21932193#define VERR_BIGNUM_NEGATIVE_EXPONENT               (-24002)
    2194 
    21952194/** @} */
    21962195
    … …  
    24932492 *  we reached the ned of the boot catalog secotr. */
    24942493#define VERR_ISOMK_IMPORT_BOOT_CAT_ENTRY_CONTINUATION_EOS           (-25157)
    2495 
    24962494/** @} */
    24972495

  • trunk/include/iprt/formats/hfs.h

    r76585 r81369  
    216216/** @} */
    217217
    218 /** @name B-tree compare types (BTHeaderRec::keyCompareType) */
     218/** @name B-tree compare types (BTHeaderRec::keyCompareType)
     219 * @{ */
    219220#define kHFSCaseFolding                 UINT8_C(0xcf)
    220221#define kHFSBinaryCompare               UINT8_C(0xbc)

  • trunk/include/iprt/formats/lx.h

    r76585 r81369  
    4040RT_C_DECLS_BEGIN
    4141
     42/** @defgroup grp_rt_formats_lx     LX executable format (OS/2)
     43 * @ingroup grp_rt_formats
     44 * @{ */
     45
    4246#ifndef IMAGE_OS2_SIGNATURE_LX
    4347/** LX signature ("LX") */
    4448# define IMAGE_LX_SIGNATURE  K_LE2H_U16('L' | ('X' << 8))
    4549#endif
    46 
    4750
    4851/**
    … …  
    202205
    203206
    204 /** @name Relocations (aka Fixups).
     207/** @defgroup grp_rt_formats_lx_relocs Relocations (aka Fixups).
    205208 * @{ */
    206209typedef union r32_offset
    … …  
    241244#pragma pack()
    242245AssertCompileSize(r32_rlc, 16);
     246/** @} */
    243247
    244248/** @name Some attempt at size constanstants.
    … …  
    287291
    288292
    289 /** @name The Object Table (aka segment table)
     293/** @defgroup grp_rt_formats_lx_object_tab The Object Table (aka segment table)
    290294 * @{ */
    291295
    … …  
    417421
    418422
    419 /** @name The Entry Table (aka Export Table)
     423/** @defgroup grp_rt_formats_lx_entry_tab  The Entry Table (aka Export Table)
    420424 * @{ */
    421425
    … …  
    500504/** @} */
    501505
    502 
     506/** @} */
    503507RT_C_DECLS_END
    504508

  • trunk/include/iprt/formats/pecoff.h

    r76585 r81369  
    15091509
    15101510/** @name WIN_CERT_REVISION_XXX - Certificate data directory revision.
    1511  * Used WIN_CERTIFICATE::wRevision found in the
    1512  * IMAGE_DIRECTORY_ENTRY_SECURITY data directory. */
     1511 * Used WIN_CERTIFICATE::wRevision found in the IMAGE_DIRECTORY_ENTRY_SECURITY
     1512 * data directory.
     1513 * @{ */
    15131514#define WIN_CERT_REVISION_1_0               UINT16_C(0x0100)
    15141515#define WIN_CERT_REVISION_2_0               UINT16_C(0x0200)

  • trunk/include/iprt/http.h

    r78659 r81369  
    277277 * @param   pszUrl          The proxy URL (libproxy style):
    278278 *
    279  *                          [{type}"://"][{userid}[@{password}]:]{server}[":"{port}]
     279 *                          [{type}"://"][{userid}[\@{password}]:]{server}[":"{port}]
    280280 *
    281281 *                          Valid proxy types are: http (default), https, socks4, socks4a,
    … …  
    568568RTR3DECL(int) RTHttpSetDownloadCallback(RTHTTP hHttp, uint32_t fFlags, PFNRTHTTPDOWNLOADCALLBACK pfnCallback, void *pvUser);
    569569
    570 /** @name RTHTTPDOWNLOAD_F_XXX */
     570/** @name RTHTTPDOWNLOAD_F_XXX
     571 * @{ */
    571572/** The lower 10 bits gives the HTTP status required by the callback.
    572573 * For all other status codes, any body data will be returned via the

  • trunk/include/iprt/latin1.h

    r76585 r81369  
    391391RT_C_DECLS_END
    392392
    393 /** @} */
    394 
    395393#endif /* !IPRT_INCLUDED_latin1_h */
    396394

  • trunk/include/iprt/list-off32.h

    r76585 r81369  
    3232#include <iprt/types.h>
    3333
    34 /* @defgroup grp_rt_list_off32 RTListOff32 - Generic Doubly Linked List based on 32-bit offset.
     34/** @defgroup grp_rt_list_off32 RTListOff32 - Generic Doubly Linked List based on 32-bit offset.
    3535 * @ingroup grp_rt
    3636 *
    37  * This is the same as @link grp_rt_list, except that instead of pointers we
     37 * This is the same as @link{grp_rt_list}, except that instead of pointers we
    3838 * use 32-bit offsets.  The list implementation is circular, with a dummy node
    3939 * as anchor.  Be careful with the dummy node when walking the list.
    … …  
    498498}
    499499
     500/** @} */
    500501RT_C_DECLS_END
    501502
    502 /** @} */
    503 
    504503#endif /* !IPRT_INCLUDED_list_off32_h */
    505504

  • trunk/include/iprt/log.h

    r79949 r81369  
    12271227
    12281228
    1229 /** @name Release Logging
     1229/** @defgroup grp_rt_log_rel    Release Logging
    12301230 * @{
    12311231 */
    … …  
    18001800
    18011801/** @name COM port logging
    1802  * {
     1802 * @{
    18031803 */
    18041804

  • trunk/include/iprt/param.h

    r76585 r81369  
    128128/** @} */
    129129
    130 
    131 /** @} */
    132 
    133130#endif /* !IPRT_INCLUDED_param_h */
    134131

  • trunk/include/iprt/shmem.h

    r78561 r81369  
    3636/** @defgroup grp_rt_shmem RTShMem - Shared memory.
    3737 * @ingroup grp_rt
     38 * @{
    3839 */
    3940

  • trunk/include/iprt/types.h

    r81096 r81369  
    17721772#define NIL_RTGCPTR64           ((RTGCPTR64)0)
    17731773
    1774 /** Guest context pointer.
    1775  * Keep in mind that this type is an unsigned integer in
    1776  * HC and void pointer in GC.
    1777  */
    1778 #if GC_ARCH_BITS == 64
     1774/** @typedef RTGCPTR
     1775 * Guest context pointer.
     1776 * Keep in mind that this type is an unsigned integer in HC and void pointer in GC. */
     1777/** @typedef PRTGCPTR
     1778 * Pointer to a guest context pointer. */
     1779/** @typedef PCRTGCPTR
     1780 * Pointer to a const guest context pointer. */
     1781/** @def NIL_RTGCPTR
     1782 * NIL GC pointer.  */
     1783/** @def RTGCPTR_MAX
     1784 * Max RTGCPTR value. */
     1785#if GC_ARCH_BITS == 64 || defined(DOXYGEN_RUNNING)
    17791786typedef RTGCPTR64               RTGCPTR;
    1780 /** Pointer to a guest context pointer. */
    17811787typedef PRTGCPTR64              PRTGCPTR;
    1782 /** Pointer to a const guest context pointer. */
    17831788typedef PCRTGCPTR64             PCRTGCPTR;
    1784 /** @def NIL_RTGCPTR
    1785  * NIL GC pointer.
    1786  */
    1787 # define NIL_RTGCPTR    NIL_RTGCPTR64
    1788 /** Max RTGCPTR value. */
     1789# define NIL_RTGCPTR            NIL_RTGCPTR64
    17891790# define RTGCPTR_MAX            UINT64_MAX
    17901791#elif GC_ARCH_BITS == 32
    17911792typedef RTGCPTR32               RTGCPTR;
    1792 /** Pointer to a guest context pointer. */
    17931793typedef PRTGCPTR32              PRTGCPTR;
    1794 /** Pointer to a const guest context pointer. */
    17951794typedef PCRTGCPTR32             PCRTGCPTR;
    1796 /** @def NIL_RTGCPTR
    1797  * NIL GC pointer.
    1798  */
    17991795# define NIL_RTGCPTR            NIL_RTGCPTR32
    1800 /** Max RTGCPTR value. */
    18011796# define RTGCPTR_MAX            UINT32_MAX
    18021797#else
    … …  
    18481843/** Pointer to a const raw mode context pointer. */
    18491844typedef const RTRCPTR   RT_FAR *PCRTRCPTR;
    1850 /** @def NIL_RTGCPTR
    1851  * NIL RC pointer.
    1852  */
     1845/** @def NIL_RTRCPTR
     1846 * NIL RC pointer.  */
    18531847#ifndef IN_RC
    18541848# define NIL_RTRCPTR            ((RTRCPTR)0)

  • trunk/include/iprt/utf16.h

    r76585 r81369  
    13831383
    13841384/** @} */
    1385 
    1386 
    13871385RT_C_DECLS_END
    13881386
    1389 /** @} */
    1390 
    13911387#endif /* !IPRT_INCLUDED_utf16_h */
    13921388

  • trunk/include/iprt/vfs.h

    r80585 r81369  
    182182
    183183
    184 /** @defgroup grp_vfs_obj           VFS Base Object API
     184/** @defgroup grp_rt_vfs_obj        VFS Base Object API
    185185 * @{
    186186 */
    … …  
    442442
    443443
    444 /** @defgroup grp_vfs_fsstream      VFS Filesystem Stream API
     444/** @defgroup grp_rt_vfs_fsstream   VFS Filesystem Stream API
    445445 *
    446446 * Filesystem streams are for tar, cpio and similar.  Any virtual filesystem can
    … …  
    567567
    568568
    569 /** @defgroup grp_vfs_dir           VFS Directory API
     569/** @defgroup grp_rt_vfs_dir        VFS Directory API
    570570 * @{
    571571 */
    … …  
    758758
    759759
    760 /** @defgroup grp_vfs_symlink       VFS Symbolic Link API
     760/** @defgroup grp_rt_vfs_symlink    VFS Symbolic Link API
    761761 *
    762762 * @remarks The TAR VFS and filesystem stream uses symbolic links for
    … …  
    861861
    862862
    863 /** @defgroup grp_vfs_iostream      VFS I/O Stream API
     863/** @defgroup grp_rt_vfs_iostream   VFS I/O Stream API
    864864 * @{
    865865 */
    … …  
    12101210
    12111211
    1212 /** @defgroup grp_vfs_file          VFS File API
     1212/** @defgroup grp_rt_vfs_file       VFS File API
    12131213 * @{
    12141214 */
    … …  
    14671467#define RTVFSFILE_SIZE_F_IS_VALID(a_fFlags) \
    14681468    ( !((a_fFlags) & ~RTVFSFILE_SIZE_F_ACTION_MASK) && ((a_fFlags) & RTVFSFILE_SIZE_F_ACTION_MASK) != 0 )
    1469 /** @} */
    1470 
    1471 
    14721469/** Mask of valid flags. */
    14731470#define RTFILE_ALLOC_SIZE_F_VALID           (RTFILE_ALLOC_SIZE_F_KEEP_SIZE)
    … …  
    15071504
    15081505
    1509 /** @defgroup grp_vfs_misc          VFS Miscellaneous
     1506/** @defgroup grp_rt_vfs_misc       VFS Miscellaneous
    15101507 * @{
    15111508 */

  • trunk/include/iprt/vfslowlevel.h

    r80585 r81369  
    553553     *          that sockets should not be opened.
    554554     * @retval  VERR_IS_A_BLOCK_DEVICE if @a pszEntry is a block device but
    555      *          @a fFlags indicates that block devices should not be opened.
    556      * @retval  VERR_IS_A_BLOCK_DEVICE if @a pszEntry is a character device but
    557      *          @a fFlags indicates that character devices should not be opened.
     555     *          @a fFlags indicates that block devices should not be opened, or vice
     556     *          versa.
    558557     *
    559558     * @param   pvThis      The implementation specific directory data.
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