VirtualBox

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


Ignore:
Timestamp:
May 11, 2023 1:01:08 AM (22 months ago)
Author:
vboxsync
svn:sync-xref-src-repo-rev:
157315
Message:

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

Location:
trunk/src/VBox/Storage
Files:
19 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/VBox/Storage/CUE.cpp

    r98103 r99739  
    334334 * Skip one character in the input stream.
    335335 *
    336  * @returns nothing.
    337336 * @param   pTokenizer    The tokenizer state.
    338337 */
     
    379378 * Sets a new line for the tokenizer.
    380379 *
    381  * @returns nothing.
    382380 * @param   pTokenizer    The tokenizer state.
    383381 * @param   cSkip         How many characters to skip.
     
    415413 * Skips all present comments too.
    416414 *
    417  * @returns nothing.
    418415 * @param   pTokenizer    The tokenizer state.
    419416 */
     
    435432 * Skips a multi line comment.
    436433 *
    437  * @returns nothing.
    438434 * @param   pTokenizer    The tokenizer state.
    439435 */
     
    449445 * Get an identifier token from the tokenizer.
    450446 *
    451  * @returns nothing.
    452447 * @param   pTokenizer    The tokenizer state.
    453448 * @param   pToken        The uninitialized token.
     
    512507 * Get an integer value or MSF location indicator from the tokenizer.
    513508 *
    514  * @returns nothing.
    515509 * @param   pTokenizer    The tokenizer state.
    516510 * @param   pToken        The uninitialized token.
     
    577571 * Parses a string constant.
    578572 *
    579  * @returns nothing.
    580573 * @param   pTokenizer    The tokenizer state.
    581574 * @param   pToken        The uninitialized token.
     
    613606 * Get the end of stream token.
    614607 *
    615  * @returns nothing.
    616608 * @param   pTokenizer    The tokenizer state.
    617609 * @param   pToken        The uninitialized token.
     
    627619 * Read the next token from the tokenizer stream.
    628620 *
    629  * @returns nothing.
    630621 * @param   pTokenizer    The tokenizer to read from.
    631622 * @param   pToken        Uninitialized token to fill the token data into.
     
    697688 * Consume the current token advancing to the next in the stream.
    698689 *
    699  * @returns nothing.
    700690 * @param   pTokenizer    The tokenizer state.
    701691 */
  • trunk/src/VBox/Storage/ISCSI.cpp

    r98103 r99739  
    839839 * Dumps an iSCSI packet if enabled.
    840840 *
    841  * @returns nothing.
    842841 * @param   pImage         The iSCSI image instance data.
    843842 * @param   paISCSISegs    Pointer to the segments array.
  • trunk/src/VBox/Storage/QCOW.cpp

    r98103 r99739  
    454454 * Creates a QCOW header from the given image state.
    455455 *
    456  * @returns nothing.
    457456 * @param   pImage     Image instance data.
    458457 * @param   pHeader    Pointer to the header to convert.
     
    500499 * Convert table entries from little endian to host endianess.
    501500 *
    502  * @returns nothing.
    503501 * @param   paTbl       Pointer to the table.
    504502 * @param   cEntries    Number of entries in the table.
     
    506504static void qcowTableConvertToHostEndianess(uint64_t *paTbl, uint32_t cEntries)
    507505{
    508     while(cEntries-- > 0)
     506    while (cEntries-- > 0)
    509507    {
    510508        *paTbl = RT_BE2H_U64(*paTbl);
     
    516514 * Convert table entries from host to little endian format.
    517515 *
    518  * @returns nothing.
    519516 * @param   paTblImg    Pointer to the table which will store the little endian table.
    520517 * @param   paTbl       The source table to convert.
    521518 * @param   cEntries    Number of entries in the table.
    522519 */
    523 static void qcowTableConvertFromHostEndianess(uint64_t *paTblImg, uint64_t *paTbl,
     520static void qcowTableConvertFromHostEndianess(uint64_t *paTblImg, uint64_t const *paTbl,
    524521                                              uint32_t cEntries)
    525522{
    526     while(cEntries-- > 0)
     523    while (cEntries-- > 0)
    527524    {
    528525        *paTblImg = RT_H2BE_U64(*paTbl);
     
    550547 * Destroys the L2 table cache.
    551548 *
    552  * @returns nothing.
    553549 * @param   pImage    The image instance data.
    554550 */
     
    609605 * Releases a L2 table cache entry.
    610606 *
    611  * @returns nothing.
    612607 * @param   pL2Entry    The L2 cache entry.
    613608 */
     
    675670 * Frees a L2 table cache entry.
    676671 *
    677  * @returns nothing.
    678672 * @param   pImage    The image instance data.
    679673 * @param   pL2Entry  The L2 cache entry to free.
     
    691685 * Inserts an entry in the L2 table cache.
    692686 *
    693  * @returns nothing.
    694687 * @param   pImage    The image instance data.
    695688 * @param   pL2Entry  The L2 cache entry to insert.
     
    790783 * Sets the L1, L2 and offset bitmasks and L1 and L2 bit shift members.
    791784 *
    792  * @returns nothing.
    793785 * @param   pImage    The image instance data.
    794786 */
     
    811803 * Converts a given logical offset into the
    812804 *
    813  * @returns nothing.
    814805 * @param   pImage         The image instance data.
    815806 * @param   off            The logical offset to convert.
  • trunk/src/VBox/Storage/QED.cpp

    r98103 r99739  
    22/** @file
    33 * QED - QED Disk image.
     4 *
     5 * The QED backend implements support for the qemu enhanced disk format (short QED)
     6 * The specification for the format is available under http://wiki.qemu.org/Features/QED/Specification
     7 *
     8 * Missing things to implement:
     9 *    - compaction
     10 *    - resizing which requires block relocation (very rare case)
    411 */
    512
     
    4451#include "VDBackends.h"
    4552#include "VDBackendsInline.h"
    46 
    47 /**
    48  * The QED backend implements support for the qemu enhanced disk format (short QED)
    49  * The specification for the format is available under http://wiki.qemu.org/Features/QED/Specification
    50  *
    51  * Missing things to implement:
    52  *    - compaction
    53  *    - resizing which requires block relocation (very rare case)
    54  */
    5553
    5654
     
    330328 * Creates a QED header from the given image state.
    331329 *
    332  * @returns nothing.
    333330 * @param   pImage     Image instance data.
    334331 * @param   pHeader    Pointer to the header to convert.
     
    352349 * Convert table entries from little endian to host endianess.
    353350 *
    354  * @returns nothing.
    355351 * @param   paTbl       Pointer to the table.
    356352 * @param   cEntries    Number of entries in the table.
     
    358354static void qedTableConvertToHostEndianess(uint64_t *paTbl, uint32_t cEntries)
    359355{
    360     while(cEntries-- > 0)
     356    while (cEntries-- > 0)
    361357    {
    362358        *paTbl = RT_LE2H_U64(*paTbl);
     
    369365 * Convert table entries from host to little endian format.
    370366 *
    371  * @returns nothing.
    372367 * @param   paTblImg    Pointer to the table which will store the little endian table.
    373368 * @param   paTbl       The source table to convert.
    374369 * @param   cEntries    Number of entries in the table.
    375370 */
    376 static void qedTableConvertFromHostEndianess(uint64_t *paTblImg, uint64_t *paTbl,
     371static void qedTableConvertFromHostEndianess(uint64_t *paTblImg, uint64_t const *paTbl,
    377372                                             uint32_t cEntries)
    378373{
    379     while(cEntries-- > 0)
     374    while (cEntries-- > 0)
    380375    {
    381376        *paTblImg = RT_H2LE_U64(*paTbl);
     
    404399 * Destroys the L2 table cache.
    405400 *
    406  * @returns nothing.
    407401 * @param   pImage    The image instance data.
    408402 */
     
    463457 * Releases a L2 table cache entry.
    464458 *
    465  * @returns nothing.
    466459 * @param   pL2Entry    The L2 cache entry.
    467460 */
     
    529522 * Frees a L2 table cache entry.
    530523 *
    531  * @returns nothing.
    532524 * @param   pImage    The image instance data.
    533525 * @param   pL2Entry  The L2 cache entry to free.
     
    545537 * Inserts an entry in the L2 table cache.
    546538 *
    547  * @returns nothing.
    548539 * @param   pImage    The image instance data.
    549540 * @param   pL2Entry  The L2 cache entry to insert.
     
    663654 * Sets the L1, L2 and offset bitmasks and L1 and L2 bit shift members.
    664655 *
    665  * @returns nothing.
    666656 * @param   pImage    The image instance data.
    667657 */
     
    685675 * Converts a given logical offset into the
    686676 *
    687  * @returns nothing.
    688677 * @param   pImage         The image instance data.
    689678 * @param   off            The logical offset to convert.
  • trunk/src/VBox/Storage/VCICache.cpp

    r98103 r99739  
    507507 * Frees a block map.
    508508 *
    509  * @returns nothing.
    510509 * @param   pBlkMap         The block bitmap to destroy.
    511510 */
     
    926925 * Frees a range of blocks.
    927926 *
    928  * @returns nothing.
    929927 * @param   pBlkMap          The block bitmap.
    930928 * @param   offBlockAddr     Address of the first block to free.
  • trunk/src/VBox/Storage/VD.cpp

    r98103 r99739  
    14871487 * Processes the list of blocked I/O contexts.
    14881488 *
    1489  * @returns nothing.
    14901489 * @param   pDisk    The disk structure.
    14911490 */
     
    36053604 * Processes a list of waiting I/O tasks. The disk lock must be held by caller.
    36063605 *
    3607  * @returns nothing.
    36083606 * @param   pDisk    The disk to process the list for.
    36093607 */
     
    36503648 * Process any I/O context on the halted list.
    36513649 *
    3652  * @returns nothing.
    36533650 * @param   pDisk    The disk.
    36543651 */
     
    37403737 * The completion is deferred if the disk is locked already.
    37413738 *
    3742  * @returns nothing.
    37433739 * @param   pIoTask  The I/O task to complete.
    37443740 */
     
    49344930 * Sets the I/O callbacks of the given interface to the fallback methods
    49354931 *
    4936  * @returns nothing.
    49374932 * @param   pIfIo    The I/O interface to setup.
    49384933 */
     
    49594954 * Sets the internal I/O callbacks of the given interface.
    49604955 *
    4961  * @returns nothing.
    49624956 * @param   pIfIoInt    The internal I/O interface to setup.
    49634957 */
  • trunk/src/VBox/Storage/VDI.cpp

    r98103 r99739  
    351351 * Internal: Init VDI header. Always use latest header version.
    352352 *
    353  * @returns nothing.
    354353 * @param   pHeader      Assumes it was initially initialized to all zeros.
    355354 * @param   uImageFlags  Flags for this image.
  • trunk/src/VBox/Storage/VHDX.cpp

    r98103 r99739  
    617617 * Converts the file identifier between file and host endianness.
    618618 *
    619  * @returns nothing.
    620619 * @param   enmConv             Direction of the conversion.
    621620 * @param   pFileIdentifierConv Where to store the converted file identifier.
     
    635634 * Converts a UUID between file and host endianness.
    636635 *
    637  * @returns nothing.
    638636 * @param   enmConv             Direction of the conversion.
    639637 * @param   pUuidConv           Where to store the converted UUID.
     
    665663 * Converts a VHDX header between file and host endianness.
    666664 *
    667  * @returns nothing.
    668665 * @param   enmConv             Direction of the conversion.
    669666 * @param   pHdrConv            Where to store the converted header.
     
    689686 * Converts a VHDX region table header between file and host endianness.
    690687 *
    691  * @returns nothing.
    692688 * @param   enmConv             Direction of the conversion.
    693689 * @param   pRegTblHdrConv      Where to store the converted header.
     
    708704 * Converts a VHDX region table entry between file and host endianness.
    709705 *
    710  * @returns nothing.
    711706 * @param   enmConv             Direction of the conversion.
    712707 * @param   pRegTblEntConv      Where to store the converted region table entry.
     
    729724 * Converts a VHDX log entry header between file and host endianness.
    730725 *
    731  * @returns nothing.
    732726 * @param   enmConv             Direction of the conversion.
    733727 * @param   pLogEntryHdrConv    Where to store the converted log entry header.
     
    753747 * Converts a VHDX log zero descriptor between file and host endianness.
    754748 *
    755  * @returns nothing.
    756749 * @param   enmConv             Direction of the conversion.
    757750 * @param   pLogZeroDescConv    Where to store the converted log zero descriptor.
     
    774767 * Converts a VHDX log data descriptor between file and host endianness.
    775768 *
    776  * @returns nothing.
    777769 * @param   enmConv             Direction of the conversion.
    778770 * @param   pLogDataDescConv    Where to store the converted log data descriptor.
     
    795787 * Converts a VHDX log data sector between file and host endianness.
    796788 *
    797  * @returns nothing.
    798789 * @param   enmConv             Direction of the conversion.
    799790 * @param   pLogDataSectorConv  Where to store the converted log data sector.
     
    815806 * Converts a BAT between file and host endianess.
    816807 *
    817  * @returns nothing.
    818808 * @param   enmConv             Direction of the conversion.
    819809 * @param   paBatEntriesConv    Where to store the converted BAT.
     
    833823 * Converts a VHDX metadata table header between file and host endianness.
    834824 *
    835  * @returns nothing.
    836825 * @param   enmConv             Direction of the conversion.
    837826 * @param   pMetadataTblHdrConv Where to store the converted metadata table header.
     
    853842 * Converts a VHDX metadata table entry between file and host endianness.
    854843 *
    855  * @returns nothing.
    856844 * @param   enmConv               Direction of the conversion.
    857845 * @param   pMetadataTblEntryConv Where to store the converted metadata table entry.
     
    873861 * Converts a VHDX file parameters item between file and host endianness.
    874862 *
    875  * @returns nothing.
    876863 * @param   enmConv               Direction of the conversion.
    877864 * @param   pFileParamsConv       Where to store the converted file parameters item entry.
     
    890877 * Converts a VHDX virtual disk size item between file and host endianness.
    891878 *
    892  * @returns nothing.
    893879 * @param   enmConv               Direction of the conversion.
    894880 * @param   pVDiskSizeConv        Where to store the converted virtual disk size item entry.
     
    908894 * Converts a VHDX page 83 data item between file and host endianness.
    909895 *
    910  * @returns nothing.
    911896 * @param   enmConv               Direction of the conversion.
    912897 * @param   pPage83DataConv       Where to store the converted page 83 data item entry.
     
    925910 * Converts a VHDX logical sector size item between file and host endianness.
    926911 *
    927  * @returns nothing.
    928912 * @param   enmConv               Direction of the conversion.
    929913 * @param   pVDiskLogSectSizeConv Where to store the converted logical sector size item entry.
     
    943927 * Converts a VHDX physical sector size item between file and host endianness.
    944928 *
    945  * @returns nothing.
    946929 * @param   enmConv                Direction of the conversion.
    947930 * @param   pVDiskPhysSectSizeConv Where to store the converted physical sector size item entry.
     
    960943 * Converts a VHDX parent locator header item between file and host endianness.
    961944 *
    962  * @returns nothing.
    963945 * @param   enmConv                Direction of the conversion.
    964946 * @param   pParentLocatorHdrConv  Where to store the converted parent locator header item entry.
     
    979961 * Converts a VHDX parent locator entry between file and host endianness.
    980962 *
    981  * @returns nothing.
    982963 * @param   enmConv                 Direction of the conversion.
    983964 * @param   pParentLocatorEntryConv Where to store the converted parent locator entry.
  • trunk/src/VBox/Storage/VMDK.cpp

    r98103 r99739  
    11661166 * Converts the grain directory from little to host endianess.
    11671167 *
    1168  * @returns nothing.
    11691168 * @param   pGD             The grain directory.
    11701169 * @param   cGDEntries      Number of entries in the grain directory to convert.
     
    73717370 * Destroys the given rename state, freeing all allocated memory.
    73727371 *
    7373  * @returns nothing.
    73747372 * @param   pRenameState    The rename state to destroy.
    73757373 */
  • trunk/src/VBox/Storage/testcase/VDIoBackend.h

    r98103 r99739  
    5050 * Completion handler.
    5151 *
    52  * @returns nothing.
     52 * @returns IPRT status code.
    5353 * @param   pvUser    Opaque user data.
    5454 * @param   rcReq     Completion code for the request.
     
    6969/**
    7070 * Destroys a memory I/O backend.
    71  *
    72  * @returns nothing.
    7371 *
    7472 * @param pIoBackend     The backend to destroy.
  • trunk/src/VBox/Storage/testcase/VDIoBackendMem.h

    r98103 r99739  
    4444/**
    4545 * Completion handler.
    46  *
    47  * @returns nothing.
     46 * 
     47 * @returns IPRT status code.
    4848 * @param   pvUser    Opaque user data.
    4949 * @param   rcReq     Completion code for the request.
  • trunk/src/VBox/Storage/testcase/VDMemDisk.h

    r98103 r99739  
    5454/**
    5555 * Destroys a memory disk.
    56  *
    57  * @returns nothing.
    5856 *
    5957 * @param pMemDisk The memory disk to destroy.
  • trunk/src/VBox/Storage/testcase/VDScript.cpp

    r98103 r99739  
    338338 * Skip one character in the input stream.
    339339 *
    340  * @returns nothing.
    341340 * @param   pTokenizer    The tokenizer state.
    342341 */
     
    383382 * Sets a new line for the tokenizer.
    384383 *
    385  * @returns nothing.
    386384 * @param   pTokenizer    The tokenizer state.
    387385 */
     
    420418 * Skips a multi line comment.
    421419 *
    422  * @returns nothing.
    423420 * @param   pTokenizer    The tokenizer state.
    424421 */
     
    443440 * Skips all present comments too.
    444441 *
    445  * @returns nothing.
    446442 * @param   pTokenizer    The tokenizer state.
    447443 */
     
    473469 * Get an identifier token from the tokenizer.
    474470 *
    475  * @returns nothing.
    476471 * @param   pTokenizer    The tokenizer state.
    477472 * @param   pToken        The uninitialized token.
     
    520515 * Get a numerical constant from the tokenizer.
    521516 *
    522  * @returns nothing.
    523517 * @param   pTokenizer    The tokenizer state.
    524518 * @param   pToken        The uninitialized token.
     
    566560 * Parses a string constant.
    567561 *
    568  * @returns nothing.
    569562 * @param   pTokenizer    The tokenizer state.
    570563 * @param   pToken        The uninitialized token.
    571564 *
    572  * @remarks: No escape sequences allowed at this time.
     565 * @remarks No escape sequences allowed at this time.
    573566 */
    574567static void vdScriptTokenizerGetStringConst(PVDTOKENIZER pTokenizer, PVDSCRIPTTOKEN pToken)
     
    598591 * Get the end of stream token.
    599592 *
    600  * @returns nothing.
    601593 * @param   pTokenizer    The tokenizer state.
    602594 * @param   pToken        The uninitialized token.
     
    613605 * Get operator or punctuator token.
    614606 *
    615  * @returns nothing.
    616607 * @param   pTokenizer    The tokenizer state.
    617608 * @param   pToken        The uninitialized token.
     
    669660 * Read the next token from the tokenizer stream.
    670661 *
    671  * @returns nothing.
    672662 * @param   pTokenizer    The tokenizer to read from.
    673663 * @param   pToken        Uninitialized token to fill the token data into.
     
    721711 * Destroys a given tokenizer state.
    722712 *
    723  * @returns nothing.
    724713 * @param   pTokenizer    The tokenizer to destroy.
    725714 */
     
    766755 * Consume the current token advancing to the next in the stream.
    767756 *
    768  * @returns nothing.
    769757 * @param   pTokenizer    The tokenizer state.
    770758 */
     
    13211309 * Parse a storage class specifier.
    13221310 *
    1323  * @returns nothing.
    13241311 * @param   pThis                The script context.
    13251312 * @param   penmStorageClass     Where to return the parsed storage classe.
     
    13551342 * Parse a type qualifier.
    13561343 *
    1357  * @returns nothing.
    13581344 * @param   pThis                The script context.
    13591345 * @param   penmTypeQualifier    Where to return the parsed type qualifier.
  • trunk/src/VBox/Storage/testcase/VDScript.h

    r98103 r99739  
    166166 * Destroys the given scripting context.
    167167 *
    168  * @returns nothing.
    169168 * @param   hScriptCtx     The script context to destroy.
    170169 */
  • trunk/src/VBox/Storage/testcase/VDScriptAst.cpp

    r98103 r99739  
    3838 * Put all child nodes of the given expression AST node onto the given to free list.
    3939 *
    40  * @returns nothing.
    4140 * @param   pList    The free list to append everything to.
    4241 * @param   pAstNode The expression node to free.
     
    147146 * Free a given statement AST node and put everything on the given to free list.
    148147 *
    149  * @returns nothing.
    150148 * @param   pList    The free list to append everything to.
    151149 * @param   pAstNode The statement node to free.
  • trunk/src/VBox/Storage/testcase/VDScriptAst.h

    r98103 r99739  
    569569 * by the given node.
    570570 *
    571  * @returns nothing.
    572571 * @param   pAstNode    The AST node to free.
    573572 */
  • trunk/src/VBox/Storage/testcase/VDScriptInterp.cpp

    r98103 r99739  
    185185 * Pops the topmost value from the value stack.
    186186 *
    187  * @returns nothing.
    188187 * @param   pThis      The interpreter context.
    189188 * @param   pVal       Where to store the value.
     
    430429 * Destroys the current scope.
    431430 *
    432  * @returns nothing.
    433431 * @param   pThis          The interpreter context.
    434432 */
  • trunk/src/VBox/Storage/testcase/VDScriptStack.h

    r98103 r99739  
    5757 * Init the stack structure.
    5858 *
    59  * @returns nothing.
    6059 * @param   pStack          The stack to initialize.
    6160 * @param   cbStackEntry    The size of one stack entry.
     
    7271 * Destroys the given stack freeing all memory.
    7372 *
    74  * @returns nothing.
    7573 * @param   pStack         The stack to destroy.
    7674 */
     
    135133 * Increases the used element count for the given stack.
    136134 *
    137  * @returns nothing.
    138135 * @param   pStack          The stack.
    139136 */
     
    146143 * Decreases the used element count for the given stack.
    147144 *
    148  * @returns nothing.
    149145 * @param   pStack          The stack.
    150146 */
  • trunk/src/VBox/Storage/testcase/tstVDIo.cpp

    r98103 r99739  
    27782778 * Executes the given script.
    27792779 *
    2780  * @returns nothing.
    27812780 * @param   pszName      The script name.
    27822781 * @param   pszScript    The script to execute.
     
    29032902 * Executes the given I/O script using the new scripting engine.
    29042903 *
    2905  * @returns nothing.
    2906  *
    29072904 * @param pcszFilename    The script to execute.
    29082905 */
     
    29302927/**
    29312928 * Run builtin tests.
    2932  *
    2933  * @returns nothing.
    29342929 */
    29352930static void tstVDIoRunBuiltinTests(void)
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