VirtualBox

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


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/Devices
Files:
57 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/VBox/Devices/Audio/AudioTest.cpp

    r99559 r99739  
    24192419 * Initializes a audio test audio beacon.
    24202420 *
    2421  * @returns VBox status code.
    24222421 * @param   pBeacon             Audio test beacon to (re-)initialize.
    24232422 * @param   uTest               Test number to set beacon to.

  • trunk/src/VBox/Devices/Audio/AudioTestService.cpp

    r98103 r99739  
    859859 * Free's (destroys) a client instance.
    860860 *
    861  * @returns nothing.
    862861 * @param   pInst               The opaque ATS instance structure.
    863862 */

  • trunk/src/VBox/Devices/Audio/AudioTestServiceClient.cpp

    r98103 r99739  
    229229 * Initializes a client request header.
    230230 *
    231  * @returns VBox status code.
    232231 * @param   pReqHdr             Request header to initialize.
    233232 * @param   cbReq               Size (in bytes) the request will have (does *not* include payload).
    … …  
    235234 * @param   cbPayload           Size (in bytes) of payload that will follow the header. Optional and can be 0.
    236235 */
    237 DECLINLINE (void) audioTestSvcClientReqHdrInit(PATSPKTHDR pReqHdr, size_t cbReq, const char *pszOp, size_t cbPayload)
     236DECLINLINE(void) audioTestSvcClientReqHdrInit(PATSPKTHDR pReqHdr, size_t cbReq, const char *pszOp, size_t cbPayload)
    238237{
    239238    AssertReturnVoid(strlen(pszOp) >= 2);
    … …  
    319318 * Destroys an ATS client.
    320319 *
    321  * @returns VBox status code.
    322320 * @param   pClient             Client to destroy.
    323321 */

  • trunk/src/VBox/Devices/Audio/DevIchAc97.cpp

    r99415 r99739  
    16241624 * Locks an AC'97 stream for serialized access.
    16251625 *
    1626  * @returns VBox status code.
    16271626 * @param   pStreamCC           The AC'97 stream to lock (ring-3).
    16281627 */
    … …  
    16361635 * Unlocks a formerly locked AC'97 stream.
    16371636 *
    1638  * @returns VBox status code.
    16391637 * @param   pStreamCC           The AC'97 stream to unlock (ring-3).
    16401638 */
    … …  
    24072405 * This is called by ichac97R3StreamsDestroy during VM poweroff & destruction.
    24082406 *
    2409  * @returns VBox status code.
    24102407 * @param   pThisCC             The ring-3 AC'97 state.
    24112408 * @param   pStream             The AC'97 stream to destroy (shared).
    … …  
    30223019 * Sets a AC'97 mixer control to a specific value.
    30233020 *
    3024  * @returns VBox status code.
    30253021 * @param   pThis               The shared AC'97 state.
    30263022 * @param   uMixerIdx           Mixer control to set value for.

  • trunk/src/VBox/Devices/EFI/FlashCore.cpp

    r98103 r99739  
    424424 * Destroys the given flash device instance.
    425425 *
    426  * @returns nothing.
    427426 * @param   pDevIns             The parent device instance.
    428427 * @param   pThis               The flash device core instance.
    … …  
    565564 * Resets the dynamic part of the flash device state.
    566565 *
    567  * @returns nothing.
    568566 * @param   pThis               The flash device core instance.
    569567 */

  • trunk/src/VBox/Devices/Graphics/DevVGA-SVGA.cpp

    r99688 r99739  
    64006400/**
    64016401 * Compute the host capabilities: device and FIFO.
     6402 *
    64026403 * Depends on 3D backend initialization.
    64036404 *
    6404  * @returns VBox status code.
    64056405 * @param   pThis     The shared VGA/VMSVGA instance data.
    64066406 * @param   pThisCC   The VGA/VMSVGA state for ring-3.
    … …  
    70907090 * Power On notification.
    70917091 *
    7092  * @returns VBox status code.
    70937092 * @param   pDevIns     The device instance data.
    70947093 *

  • trunk/src/VBox/Devices/Graphics/DevVGA.cpp

    r99315 r99739  
    40684068/**
    40694069 * Show logo bitmap data.
    4070  *
    4071  * @returns VBox status code.
    40724070 *
    40734071 * @param   cBits       Logo depth.

  • trunk/src/VBox/Devices/Input/DevPS2.cpp

    r98103 r99739  
    10101010 * Reset notification.
    10111011 *
    1012  * @returns VBox status code.
    10131012 * @param   pDevIns     The device instance data.
    10141013 */

  • trunk/src/VBox/Devices/Input/DrvKeyboardQueue.cpp

    r98103 r99739  
    416416 * Power On notification.
    417417 *
    418  * @returns VBox status code.
    419418 * @param   pDrvIns     The drive instance data.
    420419 */
    … …  
    429428 * Reset notification.
    430429 *
    431  * @returns VBox status code.
    432430 * @param   pDrvIns     The drive instance data.
    433431 */
    … …  
    443441 * Suspend notification.
    444442 *
    445  * @returns VBox status code.
    446443 * @param   pDrvIns     The drive instance data.
    447444 */
    … …  
    456453 * Resume notification.
    457454 *
    458  * @returns VBox status code.
    459455 * @param   pDrvIns     The drive instance data.
    460456 */

  • trunk/src/VBox/Devices/Input/DrvMouseQueue.cpp

    r98103 r99739  
    278278 * Power On notification.
    279279 *
    280  * @returns VBox status code.
    281280 * @param   pDrvIns     The drive instance data.
    282281 */
    … …  
    291290 * Reset notification.
    292291 *
    293  * @returns VBox status code.
    294292 * @param   pDrvIns     The drive instance data.
    295293 */
    … …  
    305303 * Suspend notification.
    306304 *
    307  * @returns VBox status code.
    308305 * @param   pDrvIns     The drive instance data.
    309306 */
    … …  
    318315 * Resume notification.
    319316 *
    320  * @returns VBox status code.
    321317 * @param   pDrvIns     The drive instance data.
    322318 */

  • trunk/src/VBox/Devices/Misc/DevPL031.cpp

    r99544 r99739  
    193193 * Updates the IRQ state based on the current device state.
    194194 *
    195  * @returns nothing.
    196195 * @param   pDevIns             The device instance.
    197196 * @param   pThis               The shared RTC instance data.

  • trunk/src/VBox/Devices/Network/DevPCNet.cpp

    r98103 r99739  
    711711 * Memory write helper to handle PCI/ISA differences.
    712712 *
    713  * @returns nothing.
    714713 * @param   pDevIns     The device instance.
    715714 * @param   pThis       Pointer to the PCNet device instance
    … …  
    730729 * Memory read helper to handle PCI/ISA differences.
    731730 *
    732  * @returns nothing.
    733731 * @param   pDevIns     The device instance.
    734732 * @param   pThis       Pointer to the PCNet device instance.

  • trunk/src/VBox/Devices/Network/DrvNAT.cpp

    r98103 r99739  
    11131113 * server changes.
    11141114 *
    1115  * @returns nothing.
    11161115 * @param   hDynStor    The DynamicStore handle.
    11171116 * @param   hChangedKey Array of changed keys we watch for.

  • trunk/src/VBox/Devices/PC/BIOS/scsi.c

    r98103 r99739  
    297297 * Enumerate attached devices.
    298298 *
    299  * @returns nothing.
    300299 * @param   hba_seg    Segement of the HBA controller block.
    301300 * @param   idx_hba    The HBA driver index used for accessing the enumerated devices.

  • trunk/src/VBox/Devices/PC/DevQemuFwCfg.cpp

    r99738 r99739  
    308308 * Cleans up any allocated resources when the item is de-selected.
    309309 *
    310  * @returns nothing.
    311310 * @param   pThis           The QEMU fw config device instance.
    312311 * @param   pItem           Pointer to the selected item.
    … …  
    778777 * Resets the currently selected item.
    779778 *
    780  * @returns nothing.
    781779 * @param   pThis               The QEMU fw config device instance.
    782780 */
    … …  
    848846 * Processes a DMA transfer.
    849847 *
    850  * @returns nothing.
    851848 * @param   pThis               The QEMU fw config device instance.
    852849 * @param   GCPhysDma           The guest physical address of the DMA descriptor.

  • trunk/src/VBox/Devices/Security/DevTpm.cpp

    r99554 r99739  
    617617 * Sets the IRQ line of the given device to the given state.
    618618 *
    619  * @returns nothing.
    620619 * @param   pDevIns             Pointer to the PDM device instance data.
    621620 * @param   pThis               Pointer to the shared TPM device.
    … …  
    631630 * Updates the IRQ status of the given locality.
    632631 *
    633  * @returns nothing.
    634632 * @param   pDevIns             Pointer to the PDM device instance data.
    635633 * @param   pThis               Pointer to the shared TPM device.
    … …  
    649647 * Sets the interrupt status for the given locality, firing an interrupt if necessary.
    650648 *
    651  * @returns nothing.
    652649 * @param   pDevIns             Pointer to the PDM device instance data.
    653650 * @param   pThis               Pointer to the shared TPM device.
    … …  
    665662 * Selects the next locality which has requested access.
    666663 *
    667  * @returns nothing.
    668664 * @param   pDevIns             Pointer to the PDM device instance data.
    669665 * @param   pThis               Pointer to the shared TPM device.
    … …  
    14571453 * Resets the shared hardware TPM state.
    14581454 *
    1459  * @returns nothing.
    14601455 * @param   pThis               Pointer to the shared TPM device.
    14611456 */

  • trunk/src/VBox/Devices/Serial/DevOxPcie958.cpp

    r98103 r99739  
    212212 * Update IRQ status of the device.
    213213 *
    214  * @returns nothing.
    215214 * @param   pDevIns             The device instance.
    216215 * @param   pThis               The shared OXPCIe958 device instance data.
    … …  
    291290 * UART core IRQ request callback.
    292291 *
    293  * @returns nothing.
    294292 * @param   pDevIns     The device instance.
    295293 * @param   pUart       The UART requesting an IRQ update.

  • trunk/src/VBox/Devices/Serial/DevPL011.cpp

    r99529 r99739  
    380380 * Updates the IRQ state based on the current device state.
    381381 *
    382  * @returns nothing.
    383382 * @param   pDevIns             The device instance.
    384383 * @param   pThis               The shared serial port instance data.
    … …  
    461460 * Updates the serial port parameters of the attached driver with the current configuration.
    462461 *
    463  * @returns nothing.
    464462 * @param   pDevIns             The device instance.
    465463 * @param   pThis               The shared serial port instance data.
    … …  
    534532 * (after a detach/attach/reset event).
    535533 *
    536  * @returns nothing.
    537534 * @param   pDevIns             The device instance.
    538535 * @param   pThis               The shared serial port instance data.
    … …  
    573570 * Tries to copy the specified amount of data from the active TX queue (register or FIFO).
    574571 *
    575  * @returns nothing.
    576572 * @param   pDevIns             The device instance.
    577573 * @param   pThis               The shared serial port instance data.

  • trunk/src/VBox/Devices/Serial/DrvHostSerial.cpp

    r98103 r99739  
    175175 * Advances the write position of the read buffer by the given amount of bytes.
    176176 *
    177  * @returns nothing.
    178177 * @param   pThis               The host serial driver instance.
    179178 * @param   cbAdv               Number of bytes to advance.
    … …  
    191190 * Advances the read position of the read buffer by the given amount of bytes.
    192191 *
    193  * @returns nothing.
    194192 * @param   pThis               The host serial driver instance.
    195193 * @param   cbAdv               Number of bytes to advance.
    … …  
    596594 * The error I/O loop.
    597595 *
    598  * @returns VBox status code.
    599596 * @param   pThis               Host serial driver instance data.
    600597 * @param   pThread             Thread instance data.

  • trunk/src/VBox/Devices/Serial/DrvTCP.cpp

    r98103 r99739  
    148148 * Closes the connection.
    149149 *
    150  * @returns nothing.
    151150 * @param   pThis                  The TCP driver instance.
    152151 */

  • trunk/src/VBox/Devices/Serial/UartCore.cpp

    r98103 r99739  
    284284 * Updates the IRQ state based on the current device state.
    285285 *
    286  * @returns nothing.
    287286 * @param   pDevIns             The device instance.
    288287 * @param   pThis               The shared serial port instance data.
    … …  
    421420 * Clears the given FIFO.
    422421 *
    423  * @returns nothing.
    424422 * @param   pFifo               The FIFO to clear.
    425423 */
    … …  
    511509 * bits set.
    512510 *
    513  * @returns nothing.
    514511 * @param   pDevIns             The device instance.
    515512 * @param   pThis               The shared serial port instance data.
    … …  
    538535 * Updates the serial port parameters of the attached driver with the current configuration.
    539536 *
    540  * @returns nothing.
    541537 * @param   pDevIns             The device instance.
    542538 * @param   pThis               The shared serial port instance data.
    … …  
    610606 * Updates the internal device state with the given PDM status line states.
    611607 *
    612  * @returns nothing.
    613608 * @param   pDevIns             The device instance.
    614609 * @param   pThis               The shared serial port instance data.
    … …  
    636631 * Fills up the receive FIFO with as much data as possible.
    637632 *
    638  * @returns nothing.
    639633 * @param   pDevIns             The device instance.
    640634 * @param   pThis               The shared serial port instance data.
    … …  
    690684 * Fetches a single byte and writes it to RBR.
    691685 *
    692  * @returns nothing.
    693686 * @param   pDevIns             The device instance.
    694687 * @param   pThis               The shared serial port instance data.
    … …  
    711704 * Fetches a ready data based on the FIFO setting.
    712705 *
    713  * @returns nothing.
    714706 * @param   pDevIns             The device instance.
    715707 * @param   pThis               The shared serial port instance data.
    … …  
    731723 * (after a detach/attach/reset event).
    732724 *
    733  * @returns nothing.
    734725 * @param   pDevIns             The device instance.
    735726 * @param   pThis               The shared serial port instance data.
    … …  
    771762 * Tries to copy the specified amount of data from the active TX queue (register or FIFO).
    772763 *
    773  * @returns nothing.
    774764 * @param   pDevIns             The device instance.
    775765 * @param   pThis               The shared serial port instance data.
    … …  
    19201910 * Resets the given UART core instance.
    19211911 *
    1922  * @returns nothing.
    19231912 * @param   pDevIns             The device instance.
    19241913 * @param   pThis               The shared serial port instance data.
    … …  
    19991988 * Detaches any attached driver from the given UART core instance.
    20001989 *
    2001  * @returns nothing.
    20021990 * @param   pDevIns             The device instance.
    20031991 * @param   pThis               The shared serial port instance data.
    … …  
    20212009 * Destroys the given UART core instance freeing all allocated resources.
    20222010 *
    2023  * @returns nothing.
    20242011 * @param   pDevIns             The device instance.
    20252012 * @param   pThis               The shared UART core instance data..

  • trunk/src/VBox/Devices/Serial/UartCore.h

    r98103 r99739  
    7272 * UART core IRQ request callback to let the core instance raise/clear interrupt requests.
    7373 *
    74  * @returns nothing.
    7574 * @param   pDevIns             The owning device instance.
    7675 * @param   pThis               The shared UART core instance data.

  • trunk/src/VBox/Devices/Storage/ATAPIPassthrough.cpp

    r98103 r99739  
    165165 * Initilizes the given track from the given CUE sheet entry.
    166166 *
    167  * @returns nothing.
    168167 * @param   pTrack             The track to initialize.
    169168 * @param   pbCueSheetEntry    CUE sheet entry to use.
    … …  
    476475 * Dump the complete track list to the release log.
    477476 *
    478  * @returns nothing.
    479477 * @param   pTrackList   The track list to dump.
    480478 */
    … …  
    517515 * Destroys the allocated task list handle.
    518516 *
    519  * @returns nothing.
    520517 * @param   pTrackList  The track list handle to destroy.
    521518 */
    … …  
    530527 * Clears all tracks from the given task list.
    531528 *
    532  * @returns nothing.
    533529 * @param   pTrackList  The track list to clear.
    534530 */

  • trunk/src/VBox/Devices/Storage/DevAHCI.cpp

    r98103 r99739  
    637637 * Memory buffer callback.
    638638 *
    639  * @returns nothing.
    640639 * @param   pDevIns  The device instance.
    641640 * @param   GCPhys   The guest physical address of the memory buffer.
    … …  
    985984 * Finishes the port reset of the given port.
    986985 *
    987  * @returns nothing.
    988986 * @param   pDevIns     The device instance.
    989987 * @param   pThis       The shared AHCI state.
    … …  
    10491047 * Kicks the I/O thread from RC or R0.
    10501048 *
    1051  * @returns nothing.
    10521049 * @param   pDevIns     The device instance.
    10531050 * @param   pAhciPort   The port to kick, shared bits.
    … …  
    25342531 * Dump info about the FIS
    25352532 *
    2536  * @returns nothing
    25372533 * @param   pAhciPort     The port the command FIS was read from (shared bits).
    25382534 * @param   cmdFis        The FIS to print info from.
    … …  
    26162612 * Dump info about the command header
    26172613 *
    2618  * @returns nothing
    26192614 * @param   pAhciPort   Pointer to the port the command header was read from
    26202615 *                      (shared bits).
    … …  
    26512646 * Post the first D2H FIS from the device into guest memory.
    26522647 *
    2653  * @returns nothing
    26542648 * @param   pDevIns     The device instance.
    26552649 * @param   pAhciPort   Pointer to the port which "receives" the FIS (shared bits).
    … …  
    29362930 * Reset all values after a reset of the attached storage device.
    29372931 *
    2938  * @returns nothing
    29392932 * @param   pDevIns     The device instance.
    29402933 * @param   pThis       The shared AHCI state.
    … …  
    29662959 * Initiates a device reset caused by ATA_DEVICE_RESET (ATAPI only).
    29672960 *
    2968  * @returns nothing.
    29692961 * @param   pDevIns     The device instance.
    29702962 * @param   pThis       The shared AHCI state.
    … …  
    29882980 * Create a PIO setup FIS and post it into the memory area of the guest.
    29892981 *
    2990  * @returns nothing.
    29912982 * @param   pDevIns     The device instance.
    29922983 * @param   pThis       The shared AHCI state.
    … …  
    30563047 * Build a D2H FIS and post into the memory area of the guest.
    30573048 *
    3058  * @returns Nothing
    30593049 * @param   pDevIns     The device instance.
    30603050 * @param   pThis       The shared AHCI state.
    … …  
    31263116 * Build a SDB Fis and post it into the memory area of the guest.
    31273117 *
    3128  * @returns Nothing
    31293118 * @param   pDevIns         The device instance.
    31303119 * @param   pThis           The shared AHCI state.
    … …  
    35853574 * Frees a given AHCI request structure.
    35863575 *
    3587  * @returns nothing.
    35883576 * @param   pAhciPortR3 The AHCI port, ring-3 bits.
    35893577 * @param   pAhciReq    The request to free.

  • trunk/src/VBox/Devices/Storage/DevATA.cpp

    r98271 r99739  
    12751275 * Enters the lock protecting the controller data against concurrent access.
    12761276 *
    1277  * @returns nothing.
    12781277 * @param   pDevIns     The device instance.
    12791278 * @param   pCtl        The controller to lock.
    … …  
    12901289 * Leaves the lock protecting the controller against concurrent data access.
    12911290 *
    1292  * @returns nothing.
    12931291 * @param   pDevIns     The device instance.
    12941292 * @param   pCtl        The controller to unlock.
    … …  
    71367134 * Resume notification.
    71377135 *
    7138  * @returns VBox status code.
    71397136 * @param   pDevIns     The device instance data.
    71407137 */
    … …  
    76017598 * Power Off notification.
    76027599 *
    7603  * @returns VBox status code.
    76047600 * @param   pDevIns     The device instance data.
    76057601 */
    … …  
    76147610 * Suspend notification.
    76157611 *
    7616  * @returns VBox status code.
    76177612 * @param   pDevIns     The device instance data.
    76187613 */

  • trunk/src/VBox/Devices/Storage/DevBusLogic.cpp

    r98103 r99739  
    10291029 * Memory buffer callback.
    10301030 *
    1031  * @returns nothing.
    10321031 * @param   pDevIns The device instance.
    10331032 * @param   pThis   Pointer to the shared BusLogic instance data.
    … …  
    10651064 * an interrupt of a different type is still pending.
    10661065 *
    1067  * @returns nothing.
    10681066 * @param   pDevIns         The device instance.
    10691067 * @param   pThis           Pointer to the shared BusLogic instance data.
    … …  
    11191117 * Deasserts the interrupt line of the BusLogic adapter.
    11201118 *
    1121  * @returns nothing.
    11221119 * @param   pDevIns     The device instance.
    11231120 * @param   pThis       Pointer to the shared BusLogic instance data.
    … …  
    11461143 * Advances the mailbox pointer to the next slot.
    11471144 *
    1148  * @returns nothing.
    11491145 * @param   pThis       Pointer to the shared BusLogic instance data.
    11501146 */
    … …  
    11571153 * Initialize local RAM of host adapter with default values.
    11581154 *
    1159  * @returns nothing.
    11601155 * @param   pThis       Pointer to the shared BusLogic instance data.
    11611156 */
    … …  
    12321227 * Note that suppressing CMDC also suppresses the interrupt, but not vice versa.
    12331228 *
    1234  * @returns nothing.
    12351229 * @param   pDevIns         The device instance.
    12361230 * @param   pThis           Pointer to the shared BusLogic instance data.
    … …  
    12631257 * Memory write helper to handle PCI/ISA differences - metadata writes.
    12641258 *
    1265  * @returns nothing.
    12661259 * @param   pDevIns     The device instance.
    12671260 * @param   pThis       Pointer to the shared BusLogic instance data.
    … …  
    12811274 * Memory read helper to handle PCI/ISA differences - metadata reads.
    12821275 *
    1283  * @returns nothing.
    12841276 * @param   pDevIns     The device instance.
    12851277 * @param   pThis       Pointer to the shared BusLogic instance data.
    … …  
    12961288}
    12971289
    1298 #if defined(IN_RING3)
     1290#ifdef IN_RING3
    12991291
    13001292/**
    13011293 * Memory write helper to handle PCI/ISA differences - userdata writes.
    13021294 *
    1303  * @returns nothing.
    13041295 * @param   pDevIns     The device instance.
    13051296 * @param   pThis       Pointer to the shared BusLogic instance data.
    … …  
    13191310 * Memory read helper to handle PCI/ISA differences - userdata reads.
    13201311 *
    1321  * @returns nothing.
    13221312 * @param   pDevIns     The device instance.
    13231313 * @param   pThis       Pointer to the shared BusLogic instance data.
    … …  
    13371327 * Initiates a hard reset which was issued from the guest.
    13381328 *
    1339  * @returns nothing
    13401329 * @param   pDevIns     The device instance.
    13411330 * @param   pThis       Pointer to the shared BusLogic instance data.
    … …  
    13631352 * Send a mailbox with set status codes to the guest.
    13641353 *
    1365  * @returns nothing.
    13661354 * @param   pDevIns                 The device instance.
    13671355 * @param   pThis                   Pointer to the shared BusLogic instance data.
    … …  
    14691457 * Dumps the content of a command control block for debugging purposes.
    14701458 *
    1471  * @returns nothing.
    14721459 * @param   pCCB            Pointer to the command control block to dump.
    14731460 * @param   fIs24BitCCB     Flag to determine CCB format.
    … …  
    18421829 * Free the sense buffer.
    18431830 *
    1844  * @returns nothing.
    18451831 * @param   pReq         Pointer to the request state.
    18461832 * @param   fCopy        If sense data should be copied to guest memory.
    … …  
    28552841 * Update the ISA I/O range.
    28562842 *
    2857  * @returns nothing.
     2843 * @returns VBox status code.
    28582844 * @param   pDevIns         The device instance.
    28592845 * @param   pThis           Pointer to the shared BusLogic instance data.
    … …  
    29142900 * Completes a request initiated by the BIOS through the BUSLOGICCOMMAND_EXECUTE_SCSI_COMMAND command.
    29152901 *
    2916  * @returns nothing.
    29172902 * @param   pThis       Pointer to the shared BusLogic instance data.
    29182903 * @param   u8ScsiSts   The SCSI status code.
    … …  
    33853370 * Processes a SCSI request issued by the BIOS with the BUSLOGICCOMMAND_EXECUTE_SCSI_COMMAND command.
    33863371 *
    3387  * @returns nothing.
    33883372 * @param   pDevIns     The device instance.
    33893373 * @param   pThis       Pointer to the shared BusLogic instance data.

  • trunk/src/VBox/Devices/Storage/DevLsiLogicSCSI.cpp

    r98103 r99739  
    101101 * Memory buffer callback.
    102102 *
    103  * @returns nothing.
    104103 * @param   pDevIns     The device instance.
    105104 * @param   GCPhys      The guest physical address of the memory buffer.
    … …  
    449448 * Updates the status of the interrupt pin of the device.
    450449 *
    451  * @returns nothing.
    452450 * @param   pDevIns     The device instance.
    453451 * @param   pThis       Pointer to the shared LsiLogic device state.
    … …  
    480478 * updates the interrupt status.
    481479 *
    482  * @returns nothing.
    483480 * @param   pDevIns     The device instance.
    484481 * @param   pThis       Pointer to the shared LsiLogic device state.
    … …  
    495492 * updates the interrupt status.
    496493 *
    497  * @returns nothing.
    498494 * @param   pDevIns     The device instance.
    499495 * @param   pThis       Pointer to the shared LsiLogic device state.
    … …  
    511507 * Sets the I/O controller into fault state and sets the fault code.
    512508 *
    513  * @returns nothing
    514509 * @param   pThis           Pointer to the shared LsiLogic device state.
    515510 * @param   uIOCFaultCode   Fault code to set.
    … …  
    618613 * Allocates the configuration pages based on the device.
    619614 *
    620  * @returns nothing.
     615 * @returns VBox status code.
    621616 * @param   pThis    Pointer to the shared LsiLogic device state.
    622617 * @param   pThisCC  Pointer to the ring-3 LsiLogic device state.
    … …  
    686681 * Frees the configuration pages if allocated.
    687682 *
    688  * @returns nothing.
    689683 * @param   pThis    Pointer to the shared LsiLogic device state.
    690684 * @param   pThisCC  Pointer to the ring-3 LsiLogic device state.
    … …  
    732726 * Finishes a context reply.
    733727 *
    734  * @returns nothing
    735728 * @param   pDevIns             The device instance.
    736729 * @param   pThis               Pointer to the shared LsiLogic device state.
    … …  
    771764 * Takes necessary steps to finish a reply frame.
    772765 *
    773  * @returns nothing
    774766 * @param   pDevIns         The device instance.
    775767 * @param   pThis           Pointer to the shared LsiLogic device state.
    … …  
    891883 * Frees all allocated memory regions.
    892884 *
    893  * @returns nothing.
    894885 * @param   pThisCC         Pointer to the ring-3 LsiLogic device state.
    895886 */
    … …  
    910901 * Inserts a given memory region into the list.
    911902 *
    912  * @returns nothing.
    913903 * @param   pThisCC         Pointer to the ring-3 LsiLogic device state.
    914904 * @param   pRegion         The region to insert.
    … …  
    955945 * Handles a write to the diagnostic data register.
    956946 *
    957  * @returns nothing.
    958947 * @param   pThis           Pointer to the shared LsiLogic device state.
    959948 * @param   pThisCC         Pointer to the ring-3 LsiLogic device state.
    … …  
    10451034 * Handles a read from the diagnostic data register.
    10461035 *
    1047  * @returns nothing.
    10481036 * @param   pThis           Pointer to the shared LsiLogic device state.
    10491037 * @param   pThisCC         Pointer to the ring-3 LsiLogic device state.
    … …  
    10771065 * Handles a write to the diagnostic memory address register.
    10781066 *
    1079  * @returns nothing.
    10801067 * @param   pThis           Pointer to the shared LsiLogic device state.
    10811068 * @param   u32Addr         Address to write.
    … …  
    10891076 * Handles a read from the diagnostic memory address register.
    10901077 *
    1091  * @returns nothing.
    10921078 * @param   pThis           Pointer to the shared LsiLogic device state.
    10931079 * @param   pu32Addr        Where to store the current address.
    … …  
    19101896 * Dump an SG entry.
    19111897 *
    1912  * @returns nothing.
    19131898 * @param   pSGEntry    Pointer to the SG entry to dump
    19141899 */
    … …  
    22202205 * Handles the completion of th given request.
    22212206 *
    2222  * @returns nothing.
    22232207 * @param   pDevIns     The device instance.
    22242208 * @param   pThis       Pointer to the shared LsiLogic device state.
    … …  
    33463330 * Initializes the configuration pages for the SPI SCSI controller.
    33473331 *
    3348  * @returns nothing
    33493332 * @param   pThis       Pointer to the shared LsiLogic device state.
    33503333 * @param   pThisCC     Pointer to the ring-3 LsiLogic device state.
    … …  
    34503433 * Generates a SAS address (WWID)
    34513434 *
    3452  * @returns nothing.
    34533435 * @param   pSASAddress Pointer to an unitialised SAS address.
    34543436 * @param   iId         iId which will go into the address.
    … …  
    34713453 * Initializes the configuration pages for the SAS SCSI controller.
    34723454 *
    3473  * @returns nothing
    34743455 * @param   pThis       Pointer to the shared LsiLogic device state.
    34753456 * @param   pThisCC     Pointer to the ring-3 LsiLogic device state.
    … …  
    36503631 * Initializes the configuration pages.
    36513632 *
    3652  * @returns nothing
    36533633 * @param   pDevIns     The device instance.
    36543634 * @param   pThis       Pointer to the shared LsiLogic device state.
    … …  
    41064086 * or loaded from a saved state.
    41074087 *
    4108  * @returns nothing.
    41094088 * @param   pDevIns     The device instance.
    41104089 * @param   pThis       Pointer to the shared LsiLogic device state.

  • trunk/src/VBox/Devices/Storage/DevVirtioSCSI.cpp

    r98661 r99739  
    721721 * Wrapper around virtioCoreR3VirtqUsedBufPut() and virtioCoreVirtqUsedRingSync() doing some device locking.
    722722 *
    723  * @returns nothing.
    724723 * @param   pDevIns         The PDM device instance.
    725724 * @param   pVirtio         Pointer to the shared virtio core structure.
    … …  
    829828 * Releases one reference from the given controller instances active request counter.
    830829 *
    831  * @returns nothing.
    832830 * @param   pDevIns     The device instance.
    833831 * @param   pThis       VirtIO SCSI shared instance data.
    … …  
    845843 * Retains one reference for the given controller instances active request counter.
    846844 *
    847  * @returns nothing.
    848845 * @param   pThis       VirtIO SCSI shared instance data.
    849846 */

  • trunk/src/VBox/Devices/Storage/DrvDiskIntegrity.cpp

    r98103 r99739  
    685685 * Adds a request to the active list.
    686686 *
    687  * @returns nothing.
    688687 * @param   pThis    The driver instance data.
    689688 * @param   pIoReq   The request to add.
    … …  
    706705 * Removes a request from the active list.
    707706 *
    708  * @returns nothing.
    709707 * @param   pThis    The driver instance data.
    710708 * @param   pIoReq   The request to remove.
    … …  
    787785 * Fires a read event if enabled.
    788786 *
    789  * @returns nothing.
    790787 * @param   pThis    The driver instance data.
    791788 * @param   uGrp     The group ID.
    … …  
    808805 * Fires a write event if enabled.
    809806 *
    810  * @returns nothing.
    811807 * @param   pThis    The driver instance data.
    812808 * @param   uGrp     The group ID.
    … …  
    829825 * Fires a flush event if enabled.
    830826 *
    831  * @returns nothing.
    832827 * @param   pThis    The driver instance data.
    833828 * @param   uGrp     The group ID.
    … …  
    848843 * Fires a request complete event if enabled.
    849844 *
    850  * @returns nothing.
    851845 * @param   pThis    The driver instance data.
    852846 * @param   uGrp     The group ID.

  • trunk/src/VBox/Devices/Storage/DrvHostBase.cpp

    r98103 r99739  
    11491149 * Deregisters statistics associated with the given media driver.
    11501150 *
    1151  * @returns nothing.
    11521151 * @param   pThis      The media driver instance.
    11531152 */

  • trunk/src/VBox/Devices/Storage/DrvRamDisk.cpp

    r98561 r99739  
    10461046 * Frees a I/O memory buffer allocated previously.
    10471047 *
    1048  * @returns nothing.
    10491048 * @param   pThis     VBox disk container instance data.
    10501049 * @param   pIoReq    I/O request for which to free memory.

  • trunk/src/VBox/Devices/Storage/DrvVD.cpp

    r98271 r99739  
    24762476 * device/driver above about the completion if requested.
    24772477 *
    2478  * @returns VBox status code.
    24792478 * @param   pThis     VBox disk container instance data.
    24802479 * @param   pIoReq    I/O request to complete.
    … …  
    30273026 * Tries to process any requests waiting for available I/O memory.
    30283027 *
    3029  * @returns nothing.
    30303028 * @param   pThis     VBox disk container instance data.
    30313029 */
    … …  
    31083106 * Frees a I/O memory buffer allocated previously.
    31093107 *
    3110  * @returns nothing.
    31113108 * @param   pThis     VBox disk container instance data.
    31123109 * @param   pIoReq    I/O request for which to free memory.
    … …  
    31863183 * Dumps the interesting bits about the given I/O request to the release log.
    31873184 *
    3188  * @returns nothing.
    31893185 * @param   pThis     VBox disk container instance data.
    31903186 * @param   pIoReq    The I/O request to dump.
    … …  
    42014197 * Deregisters statistics associated with the given media driver.
    42024198 *
    4203  * @returns nothing.
    42044199 * @param   pThis      The media driver instance.
    42054200 */
    … …  
    42844279 * Worker for the power off or destruct callback.
    42854280 *
    4286  * @returns nothing.
    42874281 * @param   pDrvIns    The driver instance.
    42884282 */

  • trunk/src/VBox/Devices/Storage/HBDMgmt-darwin.cpp

    r98103 r99739  
    124124 * Unclaims the given block device and frees its state removing it from the list.
    125125 *
    126  * @returns nothing.
    127126 * @param   pDev           The block device to unclaim.
    128127 */
    … …  
    295294 * Dummy handler for the wakeup source to kick the worker thread.
    296295 *
    297  * @returns nothing.
    298296 * @param   pInfo            Opaque user data given during source creation, unused.
    299297 */

  • trunk/src/VBox/Devices/Storage/HBDMgmt-win.cpp

    r98103 r99739  
    9595 * Unclaims the given block device and frees its state removing it from the list.
    9696 *
    97  * @returns nothing.
    9897 * @param   pDev           The block device to unclaim.
    9998 */

  • trunk/src/VBox/Devices/Storage/HBDMgmt.h

    r98103 r99739  
    5757 * Destroys the given block device manager unclaiming all managed block devices.
    5858 *
    59  * @returns nothing.
    6059 * @param   hHbdMgr     The block device manager.
    6160 */

  • trunk/src/VBox/Devices/Storage/IOBufMgmt.cpp

    r98103 r99739  
    176176 * Resets the bins to factory default (memory resigin in the largest bin).
    177177 *
    178  * @returns nothing.
    179178 * @param   pThis       The I/O buffer manager instance.
    180179 */

  • trunk/src/VBox/Devices/Storage/IOBufMgmt.h

    r98103 r99739  
    111111 * Frees a given I/O buffer.
    112112 *
    113  * @returns nothing.
    114113 * @param   pIoBufDesc         The I/O buffer descriptor to free.
    115114 */

  • trunk/src/VBox/Devices/Storage/UsbMsd.cpp

    r98103 r99739  
    10781078 * Process a completed request.
    10791079 *
    1080  * @returns nothing.
    10811080 * @param   pThis               The MSD instance.
    10821081 * @param   pReq                The request.

  • trunk/src/VBox/Devices/Storage/VSCSI/VSCSIInternal.h

    r98103 r99739  
    321321 * Completes a SCSI request and calls the completion handler.
    322322 *
    323  * @returns nothing.
    324323 * @param   pVScsiDevice    The virtual SCSI device.
    325324 * @param   pVScsiReq       The request which completed.
    … …  
    335334 * Init the sense data state.
    336335 *
    337  * @returns nothing.
    338336 * @param   pVScsiSense  The SCSI sense data state to init.
    339337 */
    … …  
    396394 * Destroys the given VPD page pool freeing all pages in it.
    397395 *
    398  * @returns nothing.
    399396 * @param   pVScsiVpdPool    The VPD page pool to destroy.
    400397 */
    … …  
    495492 * Sets the transfer size for the given request.
    496493 *
    497  * @returns nothing.
    498494 * @param   pVScsiReq     The SCSI request.
    499495 * @param   cbXfer        The transfer size for the request.
    … …  
    507503 * Sets the transfer direction for the given request.
    508504 *
    509  * @returns nothing.
    510505 * @param   pVScsiReq     The SCSI request.
    511506 * @param   cbXfer        The transfer size for the request.

  • trunk/src/VBox/Devices/Trace/DrvIfsTrace-serial.cpp

    r98103 r99739  
    431431 * Initializes serial port relaated interfaces.
    432432 *
    433  * @returns nothing.
    434433 * @param   pThis                   The interface callback trace driver instance.
    435434 */

  • trunk/src/VBox/Devices/USB/DevEHCI.cpp

    r98103 r99739  
    15231523 * is allowed to write to.
    15241524 *
    1525  * @returns nothing.
    15261525 * @param   pDevIns     The device instance.
    15271526 * @param   GCPhys      Physical guest address of the QHD.
    … …  
    47944793 * Reset notification.
    47954794 *
    4796  * @returns VBox status code.
    47974795 * @param   pDevIns     The device instance data.
    47984796 */

  • trunk/src/VBox/Devices/USB/DevOHCI.cpp

    r99367 r99739  
    948948 * Sets the HC in the unrecoverable error state and raises the appropriate interrupt.
    949949 *
    950  * @returns nothing.
    951950 * @param   pDevIns             The device instance.
    952951 * @param   pThis               The OHCI instance.
    … …  
    14811480 * in the cache.
    14821481 *
    1483  * @returns nothing.
    14841482 * @param   pPageCache  The page cache to update.
    14851483 * @param   GCPhys      The guest physical address needing the update.
    … …  
    15011499 * Update any cached ED data with the given endpoint descriptor at the given address.
    15021500 *
    1503  * @returns nothing.
    15041501 * @param   pThisCC     The OHCI instance data for the current context.
    15051502 * @param   EdAddr      Endpoint descriptor address.
    … …  
    15151512 * Update any cached TD data with the given transfer descriptor at the given address.
    15161513 *
    1517  * @returns nothing.
    15181514 * @param   pThisCC     The OHCI instance data, current context.
    15191515 * @param   TdAddr      Transfer descriptor address.
    … …  
    25562552 * Lock the given OHCI controller instance.
    25572553 *
    2558  * @returns nothing.
    25592554 * @param   pThisCC     The OHCI controller instance to lock, ring-3 edition.
    25602555 */
    … …  
    25742569 * Unlocks the given OHCI controller instance.
    25752570 *
    2576  * @returns nothing.
    25772571 * @param   pThisCC     The OHCI controller instance to unlock, ring-3 edition.
    25782572 */
    … …  
    56955689 * Reset notification.
    56965690 *
    5697  * @returns VBox status code.
    56985691 * @param   pDevIns     The device instance data.
    56995692 */
    … …  
    57195712 * Resume notification.
    57205713 *
    5721  * @returns VBox status code.
    57225714 * @param   pDevIns     The device instance data.
    57235715 */

  • trunk/src/VBox/Devices/USB/DevXHCI.cpp

    r98103 r99739  
    55205520 * Port reset done callback.
    55215521 *
    5522  * @returns nothing.
    55235522 * @param   pDevIns             The device instance data.
    55245523 * @param   iPort               The XHCI port index of the port being resetted.

  • trunk/src/VBox/Devices/USB/DrvVUSBRootHub.cpp

    r98103 r99739  
    646646 * cycles.
    647647 *
    648  * @returns nothing.
    649648 * @param   pThis    The roothub instance data.
    650649 * @param   fIdle    Flag whether the last frame didn't produce any activity.

  • trunk/src/VBox/Devices/USB/VUSBDevice.cpp

    r98103 r99739  
    11651165 * before detaching a device.
    11661166 *
    1167  * @returns nothing.
    11681167 * @param   pDev        The VUSB device instance.
    11691168 * @param   fDetaching  If set, we will unconditionally unlink (and leak)

  • trunk/src/VBox/Devices/USB/VUSBInternal.h

    r98103 r99739  
    523523 * Destroy a given URB pool freeing all ressources.
    524524 *
    525  * @returns nothing.
    526525 * @param   pUrbPool    The URB pool to destroy.
    527526 */
    … …  
    547546 * Frees a given URB.
    548547 *
    549  * @returns nothing.
    550548 * @param   pUrbPool    The URB pool the URB was allocated from.
    551549 * @param   pUrb        The URB to free.
    … …  
    554552
    555553#ifdef LOG_ENABLED
     554
    556555/**
    557556 * Logs an URB in the debug log.
    558557 *
    559  * @returns nothing.
    560558 * @param   pUrb        The URB to log.
    561559 * @param   pszMsg      Additional message to log.
    … …  
    578576 */
    579577DECLHIDDEN(const char *) vusbUrbStatusName(VUSBSTATUS enmStatus);
    580 #endif
     578
     579#endif /* LOG_ENABLED*/
    581580
    582581DECLINLINE(void) vusbUrbUnlink(PVUSBURB pUrb)

  • trunk/src/VBox/Devices/USB/VUSBSniffer.cpp

    r98103 r99739  
    202202 * Destroys the given VUSB sniffer instance.
    203203 *
    204  * @returns nothing.
    205204 * @param   hSniffer              The sniffer instance to destroy.
    206205 */

  • trunk/src/VBox/Devices/USB/VUSBSniffer.h

    r98103 r99739  
    9191 * Destroys the given VUSB sniffer instance.
    9292 *
    93  * @returns nothing.
    9493 * @param   hSniffer              The sniffer instance to destroy.
    9594 */

  • trunk/src/VBox/Devices/USB/VUSBSnifferInternal.h

    r98103 r99739  
    8888     * Destroys the format instance.
    8989     *
    90      * @returns nothing.
    9190     * @param   pThis    Pointer to the format specific state.
    9291     */

  • trunk/src/VBox/Devices/USB/VUSBUrb.cpp

    r98103 r99739  
    472472/**
    473473 * Send a control message *synchronously*.
    474  * @return
    475474 */
    476475static void vusbMsgSubmitSynchronously(PVUSBURB pUrb, bool fSafeRequest)
    … …  
    13051304 * Reap URBs on a per device level.
    13061305 *
    1307  * @returns nothing.
    13081306 * @param   pDev        The device instance to reap URBs for.
    13091307 * @param   cMillies    Number of milliseconds to block in each reap operation.

  • trunk/src/VBox/Devices/USB/darwin/USBProxyDevice-darwin.cpp

    r98103 r99739  
    310310 * or to pick up completed URBs.
    311311 *
    312  * @returns nothing.
    313312 * @param   pDevOsX    The darwin device instance data.
    314313 */

  • trunk/src/VBox/Devices/USB/linux/USBProxyDevice-linux.cpp

    r98103 r99739  
    260260 * Links the given URB into the in flight list.
    261261 *
    262  * @returns nothing.
    263262 * @param   pDevLnx         The proxy device instance - Linux specific data.
    264263 * @param   pUrbLnx         The URB to link into the in flight list.
    … …  
    276275 * Unlinks the given URB from the in flight list.
    277276 *
    278  * @returns nothing.
    279277 * @param   pDevLnx         The proxy device instance - Linux specific data.
    280278 * @param   pUrbLnx         The URB to link into the in flight list.

  • trunk/src/VBox/Devices/USB/usbip/USBProxyDevice-usbip.cpp

    r98103 r99739  
    457457 * Converts a request/reply header from network to host endianness.
    458458 *
    459  * @returns nothing.
    460459 * @param   pHdr    The header to convert.
    461460 */
    … …  
    472471 * Converts a request/reply header from host to network endianness.
    473472 *
    474  * @returns nothing.
    475473 * @param   pHdr              The header to convert.
    476474 */
    … …  
    487485 * Converts a submit request from host to network endianness.
    488486 *
    489  * @returns nothing.
    490487 * @param   pReqSubmit        The submit request to convert.
    491488 */
    … …  
    503500 * Converts a submit reply from network to host endianness.
    504501 *
    505  * @returns nothing.
    506502 * @param   pReqSubmit        The submit reply to convert.
    507503 */
    … …  
    519515 * Converts a isochronous packet descriptor from host to network endianness.
    520516 *
    521  * @returns nothing.
    522517 * @param   pIsocPktDesc      The packet descriptor to convert.
    523518 */
    … …  
    533528 * Converts a isochronous packet descriptor from network to host endianness.
    534529 *
    535  * @returns nothing.
    536530 * @param   pIsocPktDesc      The packet descriptor to convert.
    537531 */
    … …  
    547541 * Converts a unlink request from host to network endianness.
    548542 *
    549  * @returns nothing.
    550543 * @param   pReqUnlink        The unlink request to convert.
    551544 */
    … …  
    559552 * Converts a unlink reply from network to host endianness.
    560553 *
    561  * @returns nothing.
    562554 * @param   pRetUnlink        The unlink reply to convert.
    563555 */
    … …  
    571563 * Convert the given exported device structure from host to network byte order.
    572564 *
    573  * @returns nothing.
    574565 * @param   pDevice           The device structure to convert.
    575566 */
    … …  
    624615 * Links a given URB into the given list.
    625616 *
    626  * @returns nothing.
    627617 * @param   pProxyDevUsbIp    The USB/IP proxy device data.
    628618 * @param   pList             The list to link the URB into.
    … …  
    640630 * Unlinks a given URB from the current assigned list.
    641631 *
    642  * @returns nothing.
    643632 * @param   pProxyDevUsbIp    The USB/IP proxy device data.
    644633 * @param   pUrbUsbIp         The URB to unlink.
    … …  
    667656 * Frees the given USB/IP URB state.
    668657 *
    669  * @returns nothing.
    670658 * @param   pProxyDevUsbIp    The USB/IP proxy device data.
    671659 * @param   pUrbUsbIp         The USB/IP speciic URB data.
    … …  
    897885 * Resets the receive state for a new reply.
    898886 *
    899  * @returns nothing.
    900887 * @param  pProxyDevUsbIp    The USB/IP proxy device data.
    901888 */

  • trunk/src/VBox/Devices/VMMDev/VMMDevTesting.cpp

    r98103 r99739  
    999999 * Initializes the testing part of the VMMDev if enabled.
    10001000 *
    1001  * @returns VBox status code.
    10021001 * @param   pDevIns             The VMMDev device instance.
    10031002 */

  • trunk/src/VBox/Devices/VirtIO/VirtioCore.h

    r98103 r99739  
    551551 * Resets the device state upon a VM reset for instance.
    552552 *
    553  * @returns nothing.
    554553 * @param   pVirtio     Pointer to the virtio state.
    555554 *

  • trunk/src/VBox/Devices/testcase/tstDeviceCfg.cpp

    r98103 r99739  
    7676 * Destroys the given configuration item array freeing all allocated resources.
    7777 *
    78  * @returns nothing.
    7978 * @param   paCfg               The configuration item array to destroy.
    8079 * @param   cCfgItems           Number of items in the array.

  • trunk/src/VBox/Devices/testcase/tstDeviceCfg.h

    r98103 r99739  
    161161 * Destroys the given test configuration freeing all allocated resources.
    162162 *
    163  * @returns nothing.
    164163 * @param   pDevTstCfg              The test configuration to destroy.
    165164 */
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