Changeset 99739 in vbox for trunk/src/VBox/Main/src-client

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/Main/src-client

Files:

• ConsoleImpl.cpp (modified) (1 diff)
• DisplayImpl.cpp (modified) (1 diff)
• DrvAudioRec.cpp (modified) (1 diff)
• GuestImpl.cpp (modified) (1 diff)
• HGCM.cpp (modified) (2 diffs)
• KeyboardImpl.cpp (modified) (1 diff)
• MouseImpl.cpp (modified) (1 diff)
• RecordingInternals.cpp (modified) (4 diffs)

trunk/src/VBox/Main/src-client/ConsoleImpl.cpp

@@ -11873 +11873 @@
  * Destruct a status driver instance.
  *
- * @returns VBox status code.
  * @param   pDrvIns     The driver instance data.
  */

trunk/src/VBox/Main/src-client/DisplayImpl.cpp

@@ -3686 +3686 @@
  * Destruct a display driver instance.
  *
- * @returns VBox status code.
  * @param   pDrvIns     The driver instance data.
  */

trunk/src/VBox/Main/src-client/DrvAudioRec.cpp

@@ -630 +630 @@
  * Shuts down (closes) a recording sink,
  *
- * @returns VBox status code.
  * @param   pSink               Recording sink to shut down.
  */

trunk/src/VBox/Main/src-client/GuestImpl.cpp

@@ -1081 +1081 @@
  * Issued by the guest when a guest user changed its state.
  *
- * @return  IPRT status code.
  * @param   aUser               Guest user name.
  * @param   aDomain             Domain of guest user account. Optional.

trunk/src/VBox/Main/src-client/HGCM.cpp

@@ -469 +469 @@
 }
 
-/** Helper function to free a local service DLL.
- *
- *  @return VBox code
+/**
+ * Helper function to free a local service DLL.
  */
 void HGCMService::unloadServiceDLL(void)
@@ -2099 +2098 @@
  * @param   pCmd           The VBox HGCM context.
  * @param   idClient       The client handle to be disconnected and deleted.
- * @return  VBox status code.
  */
 void HGCMService::GuestCancelled(PPDMIHGCMPORT pHGCMPort, PVBOXHGCMCMD pCmd, uint32_t idClient)

trunk/src/VBox/Main/src-client/KeyboardImpl.cpp

@@ -411 +411 @@
  * Destruct a keyboard driver instance.
  *
- * @returns VBox status code.
  * @param   pDrvIns     The driver instance data.
  */

trunk/src/VBox/Main/src-client/MouseImpl.cpp

@@ -1263 +1263 @@
  * Destruct a mouse driver instance.
  *
- * @returns VBox status code.
  * @param   pDrvIns     The driver instance data.
  */

trunk/src/VBox/Main/src-client/RecordingInternals.cpp

@@ -32 +32 @@
 
 #ifdef VBOX_WITH_AUDIO_RECORDING
+
 /**
  * Initializes a recording frame.
@@ -93 +94 @@
     pFrame = NULL;
 }
-#endif
+
+#endif /* VBOX_WITH_AUDIO_RECORDING */
 
 /**
@@ -113 +115 @@
  * Frees a recording video frame.
  *
- * @returns VBox status code.
  * @param   pFrame              Pointer to video frame to free. The pointer will be invalid after return.
  */
@@ -129 +130 @@
  * Frees a recording frame.
  *
- * @returns VBox status code.
  * @param   pFrame              Pointer to recording frame to free. The pointer will be invalid after return.
  */