VirtualBox

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


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/USB
Files:
13 edited

Legend:

Unmodified
Added
Removed

  • 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 */
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