utils

Timestamp:

May 11, 2023 1:01:08 AM (2 years 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/ValidationKit/utils

Files:

trunk/src/VBox/ValidationKit/utils/serial/SerialTest.cpp

-              r98103
+              r99739
  * Initializes a TX buffer.
+ *
- * @returns nothing.
  * @param   pSerBuf             The serial buffer to initialize.
  * @param   cbTx                Maximum number of bytes to transmit.
 …
  * Initializes a RX buffer.
+ *
- * @returns nothing.
  * @param   pSerBuf             The serial buffer to initialize.
  * @param   cbRx                Maximum number of bytes to receive.
 …
  * Prepares the given TX buffer with data for sending it out.
+ *
- * @returns nothing.
  * @param   pSerBuf             The TX buffer pointer.
  */

-              r98763
+              r99739
  * Initialize the given request for submission.
+ *
- * @returns nothing.
  * @param   pJob                The job data for the current worker.
  * @param   pIoReq              The request to initialize.
 …
  * Frees allocated resources specific for the current test.
+ *
- * @returns nothing.
  * @param   pJob                The job data for the current worker.
  */
 …
  * test finished.
+ *
- * @returns nothing.
  * @param   pJob                The job data.
  */

r98103	r99739
478	478	* Test execution worker.
479	479	*
480		* @returns nothing.
481	480	* @param pszDevice The device to use for testing.
482	481	*/

r98103	r99739
1070	1070	* Destroys a client instance.
1071	1071	*
1072		* @returns nothing.
1073	1072	* @param pClient The UTS client structure.
1074	1073	*/

r98103	r99739
89	89	* Destroys a gadget instance.
90	90	*
91		* @returns nothing.
92	91	* @param pThis The gadget instance.
93	92	*/

r98103	r99739
244	244	* Cleans up any leftover configurations from the gadget class.
245	245	*
246		* @returns nothing.
247	246	* @param pClass The gadget class instance data.
248	247	*/

r98103	r99739
88	88	* Destroys a gadget host instance.
89	89	*
90		* @returns nothing.
91	90	* @param pThis The gadget host instance.
92	91	*/

r98103	r99739
77	77	* Terminates the gadget host interface.
78	78	*
79		* @returns nothing.
80	79	* @param pIf The interface specific instance data.
81	80	*/

r98103	r99739
77	77	* Terminates the gadget class instance.
78	78	*
79		* @returns nothing.
80	79	* @param pClass The interface specific instance data.
81	80	*/

-              r98103
+              r99739
  * Converts a UTS packet header from host to network byte order.
+ *
- * @returns nothing.
  * @param   pPktHdr          The packet header to convert.
  */
 …
  * Converts a UTS packet header from network to host byte order.
+ *
- * @returns nothing.
  * @param   pPktHdr          The packet header to convert.
  */
 …
  * Converts a UTS status header from host to network byte order.
+ *
- * @returns nothing.
  * @param   pPktHdr          The packet header to convert.
  */
 …
  * Converts a UTS status header from network to host byte order.
+ *
- * @returns nothing.
  * @param   pPktHdr          The packet header to convert.
  */

-              r98103
+              r99739
  * Converts a UTS request packet from host to network byte ordering.
+ *
- * @returns nothing.
  * @param   pPktHdr           The packet to convert.
  */
 …
  * Converts a UTS request packet from network to host byte ordering.
+ *
- * @returns nothing.
  * @param   pPktHdr           The packet to convert.
  */
 …
  * Converts a UTS reply packet from host to network byte ordering.
+ *
- * @returns nothing.
  * @param   pPktHdr           The packet to convert.
  */
 …
  * Converts a UTS reply packet from network to host byte ordering.
+ *
- * @returns nothing.
  * @param   pPktHdr           The packet to convert.
  */

Note: See TracChangeset for help on using the changeset viewer.