VirtualBox

Changeset 99739 in vbox for trunk/src/VBox/Runtime


Ignore:
Timestamp:
May 11, 2023 1:01:08 AM (19 months ago)
Author:
vboxsync
Message:

*: doxygen corrections (mostly about removing @returns from functions returning void).

Location:
trunk/src/VBox/Runtime
Files:
21 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/VBox/Runtime/Doxyfile

    r99727 r99739  
    21362136    RT_ASM_DECL_PRAGMA_WATCOM_386(type)=type \
    21372137    DECLNORETURN(type)=type \
     2138    DECL_CHECK_RETURN(type)=type \
     2139    DECL_CHECK_RETURN_NOT_R3(type)=type \
    21382140    RTCALL=
    21392141

  • trunk/src/VBox/Runtime/common/dvm/dvmbsdlabel.cpp

    r98103 r99739  
    210210 * Converts a partition entry to the host endianness.
    211211 *
    212  * @returns nothing.
    213212 * @param   pPartition    The partition to decode.
    214213 */

  • trunk/src/VBox/Runtime/common/efi/efivarstorevfs.cpp

    r99423 r99739  
    333333
    334334#ifdef LOG_ENABLED
     335
    335336/**
    336337 * Logs a firmware volume header.
    337338 *
    338  * @returns nothing.
    339339 * @param   pFvHdr              The firmware volume header.
    340340 */
    … …  
    361361 * Logs a variable store header.
    362362 *
    363  * @returns nothing.
    364363 * @param   pStoreHdr           The variable store header.
    365364 */
    … …  
    380379 * Logs a authenticated variable header.
    381380 *
    382  * @returns nothing.
    383381 * @param   pVarHdr             The authenticated variable header.
    384382 * @param   offVar              Offset of the authenticated variable header.
    … …  
    411409    }
    412410}
    413 #endif
    414 
     411
     412#endif /* LOG_ENABLED */
    415413
    416414/**

  • trunk/src/VBox/Runtime/common/fs/extvfs.cpp

    r98103 r99739  
    271271
    272272#ifdef LOG_ENABLED
     273
    273274/**
    274275 * Logs the ext filesystem superblock.
    275276 *
    276  * @returns nothing.
    277277 * @param   pSb                 Pointer to the superblock.
    278278 */
    … …  
    416416 * Logs a ext filesystem block group descriptor.
    417417 *
    418  * @returns nothing.
    419418 * @param   pThis               The ext volume instance.
    420419 * @param   iBlockGroup         Block group number.
    … …  
    460459 * Logs a ext filesystem inode.
    461460 *
    462  * @returns nothing.
    463461 * @param   pThis               The ext volume instance.
    464462 * @param   iInode              Inode number.
    … …  
    521519 * Logs a ext filesystem directory entry.
    522520 *
    523  * @returns nothing.
    524521 * @param   pThis               The ext volume instance.
    525522 * @param   idxDirEntry         Directory entry index number.
    … …  
    554551 * Logs an extent header.
    555552 *
    556  * @returns nothing.
    557553 * @param   pExtentHdr          The extent header node.
    558554 */
    … …  
    574570 * Logs an extent index node.
    575571 *
    576  * @returns nothing.
    577572 * @param   pExtentIdx          The extent index node.
    578573 */
    … …  
    592587 * Logs an extent.
    593588 *
    594  * @returns nothing.
    595589 * @param   pExtent             The extent.
    596590 */
    … …  
    606600    }
    607601}
    608 #endif
    609 
     602
     603#endif /* LOG_ENABLED */
    610604
    611605/**
    … …  
    723717 * Frees the given block.
    724718 *
    725  * @returns nothing.
    726719 * @param   pThis               The ext volume instance.
    727720 * @param   pBlock              The block to free.
    … …  
    809802 * Releases a reference of the given block.
    810803 *
    811  * @returns nothing.
    812804 * @param   pThis               The ext volume instance.
    813805 * @param   pBlock              The block to release.
    … …  
    847839 * Frees the given block group.
    848840 *
    849  * @returns nothing.
    850841 * @param   pThis               The ext volume instance.
    851842 * @param   pBlockGroup         The block group to free.
    … …  
    985976 * Releases a reference of the given block group.
    986977 *
    987  * @returns nothing.
    988978 * @param   pThis               The ext volume instance.
    989979 * @param   pBlockGroup         The block group to release.
    … …  
    10211011 * Frees the given inode.
    10221012 *
    1023  * @returns nothing.
    10241013 * @param   pThis               The ext volume instance.
    10251014 * @param   pInode              The inode to free.
    … …  
    12361225 * Releases a reference of the given inode.
    12371226 *
    1238  * @returns nothing.
    12391227 * @param   pThis               The ext volume instance.
    12401228 * @param   pInode              The inode to release.

  • trunk/src/VBox/Runtime/common/fs/xfsvfs.cpp

    r98103 r99739  
    267267 * Logs the XFS filesystem superblock.
    268268 *
    269  * @returns nothing.
    270269 * @param   iAg                 The allocation group number for the given super block.
    271270 * @param   pSb                 Pointer to the superblock.
    … …  
    349348 * Logs a AG free space block.
    350349 *
    351  * @returns nothing.
    352350 * @param   iAg                 The allocation group number for the given free space block.
    353351 * @param   pAgf                The AG free space block.
    … …  
    388386 * Loads an AG inode information block.
    389387 *
    390  * @returns nothing.
    391388 * @param   iAg                 The allocation group number for the given inode information block.
    392389 * @param   pAgi                The AG inode information block.
    … …  
    419416 * Logs a XFS filesystem inode.
    420417 *
    421  * @returns nothing.
    422418 * @param   pThis               The XFS volume instance.
    423419 * @param   iInode              Inode number.
    … …  
    492488 * Logs a XFS filesystem directory entry.
    493489 *
    494  * @returns nothing.
    495490 * @param   pThis               The XFS volume instance.
    496491 * @param   idxDirEntry         Directory entry index number.
    … …  
    537532 * and the offset into the block where to find the inode structure.
    538533 *
    539  * @returns nothing.
    540534 * @param   pThis               The XFS volume instance.
    541535 * @param   iInode              The inode to split.
    … …  
    648642 * Frees the given block.
    649643 *
    650  * @returns nothing.
    651644 * @param   pThis               The XFS volume instance.
    652645 * @param   pBlock              The block to free.
    … …  
    734727 * Releases a reference of the given block.
    735728 *
    736  * @returns nothing.
    737729 * @param   pThis               The XFS volume instance.
    738730 * @param   pBlock              The block to release.
    … …  
    770762 * Frees the given allocation group.
    771763 *
    772  * @returns nothing.
    773764 * @param   pThis               The XFS volume instance.
    774765 * @param   pAg                 The allocation group to free.
    … …  
    889880 * Releases a reference of the given allocation group.
    890881 *
    891  * @returns nothing.
    892882 * @param   pThis               The XFS volume instance.
    893883 * @param   pAg                 The allocation group to release.
    … …  
    926916 * Frees the given inode.
    927917 *
    928  * @returns nothing.
    929918 * @param   pThis               The XFS volume instance.
    930919 * @param   pInode              The inode to free.
    … …  
    11331122 * Releases a reference of the given inode.
    11341123 *
    1135  * @returns nothing.
    11361124 * @param   pThis               The XFS volume instance.
    11371125 * @param   pInode              The inode to release.

  • trunk/src/VBox/Runtime/common/fuzz/fuzz-config.cpp

    r98103 r99739  
    520520 * Destroys the given fuzzing config.
    521521 *
    522  * @returns nothing.
    523522 * @param   pThis                   The fuzzing config instance to destroy.
    524523 */

  • trunk/src/VBox/Runtime/common/fuzz/fuzz-observer.cpp

    r98103 r99739  
    439439 * Destroys the given execution context.
    440440 *
    441  * @returns nothing.
    442441 * @param   pThis               The internal fuzzing observer state.
    443442 * @param   pExecCtx            The execution context to destroy.

  • trunk/src/VBox/Runtime/common/fuzz/fuzz-target-recorder.cpp

    r98103 r99739  
    185185 * Initializes the given stdout/stderr buffer.
    186186 *
    187  * @returns nothing.
    188187 * @param   pBuf                The buffer to initialize.
    189188 */
    … …  
    199198 * Frees all allocated resources in the given stdout/stderr buffer.
    200199 *
    201  * @returns nothing.
    202200 * @param   pBuf                The buffer to free.
    203201 */
    … …  
    358356 * Destorys the given fuzzer target recorder freeing all allocated resources.
    359357 *
    360  * @returns nothing.
    361358 * @param   pThis               The fuzzer target recorder instance.
    362359 */
    … …  
    370367 * Destroys the given fuzzer target state freeing all allocated resources.
    371368 *
    372  * @returns nothing.
    373369 * @param   pThis               The fuzzed target state instance.
    374370 */

  • trunk/src/VBox/Runtime/common/fuzz/fuzz.cpp

    r98103 r99739  
    575575 * Frees the given memory.
    576576 *
    577  * @returns nothing.
    578577 * @param   pThis               The fuzzer context instance.
    579578 * @param   pv                  Pointer to the memory area to free.
    … …  
    620619 * Updates the cache status of the given mutation.
    621620 *
    622  * @returns nothing.
    623621 * @param   pThis               The fuzzer context instance.
    624622 * @param   pMutation           The mutation to update.
    … …  
    655653 * Removes a cached mutation from the cache.
    656654 *
    657  * @returns nothing.
    658655 * @param   pThis               The fuzzer context instance.
    659656 * @param   pMutation           The mutation to remove.
    … …  
    675672 * Destroys the given mutation.
    676673 *
    677  * @returns nothing.
    678674 * @param   pMutation           The mutation to destroy.
    679675 */
    … …  
    870866 * Destroys the given fuzzer context freeing all allocated resources.
    871867 *
    872  * @returns nothing.
    873868 * @param   pThis               The fuzzer context instance.
    874869 */
    … …  
    15131508 * Destroys the given fuzzing input.
    15141509 *
    1515  * @returns nothing.
    15161510 * @param   pThis               The fuzzing input to destroy.
    15171511 */

  • trunk/src/VBox/Runtime/common/fuzz/fuzzmastercmd.cpp

    r98103 r99739  
    15801580 * Destroys all running fuzzers for the given master state.
    15811581 *
    1582  * @returns nothing.
    15831582 * @param   pThis               The fuzzing master command state.
    15841583 */
    … …  
    15921591 * Sends an ACK response to the client.
    15931592 *
    1594  * @returns nothing.
    15951593 * @param   hSocket             The socket handle to send the ACK to.
    15961594 * @param   pszResponse         Additional response data.
    … …  
    16231621 * Sends an NACK response to the client.
    16241622 *
    1625  * @returns nothing.
    16261623 * @param   hSocket             The socket handle to send the ACK to.
    16271624 * @param   pErrInfo            Optional error information to send along.

  • trunk/src/VBox/Runtime/common/ioqueue/ioqueue-stdfile-provider.cpp

    r98103 r99739  
    153153 * Processes the given submission queue entry and reports back the result in the completion queue.
    154154 *
    155  * @returns nothing.
    156155 * @param   pSqEntry            The submission queue entry to process.
    157156 * @param   pCqEntry            The comppletion queue entry to store the result in.

  • trunk/src/VBox/Runtime/common/log/tracelogreader.cpp

    r98103 r99739  
    305305 * Converts the header endianess to the host endianess.
    306306 *
    307  * @returns nothing.
    308307 * @param   pHdr                The trace log header to convert.
    309308 */
    … …  
    321320 * Converts the event descriptor endianess to the host endianess.
    322321 *
    323  * @returns nothing.
    324322 * @param   pEvtDesc            The trace log event descriptor to convert.
    325323 */
    … …  
    337335 * Converts the event item descriptor endianess to host endianess.
    338336 *
    339  * @returns nothing.
    340337 * @param   pEvtItemDesc        The trace log event item descriptor to convert.
    341338 */
    … …  
    352349 * Converts the event marker endianess to host endianess.
    353350 *
    354  * @returns nothing.
    355351 * @param   pEvt                The trace log event marker to convert.
    356352 */
    … …  
    533529 * Calculates the overall event data size from the items in the event descriptor.
    534530 *
    535  * @returns nothing.
    536531 * @param   pThis               The trace log reader instance.
    537532 * @param   pEvtDesc            The event descriptor.

  • trunk/src/VBox/Runtime/common/misc/json.cpp

    r98103 r99739  
    362362 * Skip one character in the input stream.
    363363 *
    364  * @returns nothing.
    365364 * @param   pTokenizer      The tokenizer state.
    366365 */
    … …  
    407406 * Sets a new line for the tokenizer.
    408407 *
    409  * @returns nothing.
    410408 * @param   pTokenizer      The tokenizer state.
    411409 * @param   cSkip           Amount of characters to skip making up the new line.
    … …  
    446444 * Skips all present comments too.
    447445 *
    448  * @returns nothing.
    449446 * @param   pTokenizer      The tokenizer state.
    450447 */
    … …  
    948945 * Cleans up any resources still in control of the given token.
    949946 *
    950  * @returns nothing.
    951947 * @param   pToken              The toke nto clean up.
    952948 */
    … …  
    961957 * Destroys a given tokenizer state.
    962958 *
    963  * @returns nothing.
    964959 * @param   pTokenizer      The tokenizer to destroy.
    965960 */
    … …  
    991986 * Consume the current token advancing to the next in the stream.
    992987 *
    993  * @returns nothing.
    994988 * @param   pTokenizer    The tokenizer state.
    995989 */
    … …  
    10311025 * Destroys a given JSON value releasing the reference to all child values.
    10321026 *
    1033  * @returns nothing.
    10341027 * @param   pThis           The JSON value to destroy.
    10351028 */

  • trunk/src/VBox/Runtime/common/zip/tarvfswriter.cpp

    r98458 r99739  
    512512 * Formats a given 32-bit value into a CPIO header field.
    513513 *
    514  * @returns nothing.
    515514 * @param   pach8Field      The field to format the value into.
    516515 * @param   u32             The value to format.

  • trunk/src/VBox/Runtime/include/internal/dvm.h

    r98103 r99739  
    128128     * Closes the volume format.
    129129     *
    130      * @returns nothing.
    131130     * @param   hVolMgrFmt      The format specific volume manager handle.
    132131     */
    … …  
    220219     * Closes a volume handle.
    221220     *
    222      * @returns nothing.
    223221     * @param   hVolFmt         The format specific volume handle.
    224222     */

  • trunk/src/VBox/Runtime/r3/darwin/krnlmod-darwin.cpp

    r98103 r99739  
    167167 * Destroy the given kernel module information record.
    168168 *
    169  * @returns nothing.
    170169 * @param   pThis            The record to destroy.
    171170 */

  • trunk/src/VBox/Runtime/r3/linux/ioqueue-iouringfile-provider.cpp

    r98103 r99739  
    556556 * Checks the completion event queue for pending events.
    557557 *
    558  * @returns nothing.
    559558 * @param   pThis               The provider instance.
    560559 * @param   paCEvt              Pointer to the array of completion events.

  • trunk/src/VBox/Runtime/r3/linux/krnlmod-linux.cpp

    r98103 r99739  
    7979 * Destroy the given kernel module information record.
    8080 *
    81  * @returns nothing.
    8281 * @param   pThis            The record to destroy.
    8382 */

  • trunk/src/VBox/Runtime/r3/posix/serialport-posix.cpp

    r98103 r99739  
    645645 * Shuts down the status line monitor thread.
    646646 *
    647  * @returns nothing.
    648647 * @param   pThis                   The internal serial port instance data.
    649648 */

  • trunk/src/VBox/Runtime/r3/solaris/krnlmod-solaris.cpp

    r98103 r99739  
    8080 * Destroy the given kernel module information record.
    8181 *
    82  * @returns nothing.
    8382 * @param   pThis            The record to destroy.
    8483 */

  • trunk/src/VBox/Runtime/r3/win/krnlmod-win.cpp

    r98103 r99739  
    8181 * Destroy the given kernel module information record.
    8282 *
    83  * @returns nothing.
    8483 * @param   pThis            The record to destroy.
    8584 */
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