Changeset 87566 in vbox for trunk/src/VBox/HostServices/SharedClipboard

Timestamp:

Feb 3, 2021 1:48:48 PM (4 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

142593

Message:

Shared Clipboard: doxygen fixes for unnecessary @copydoc in definitions and duplicate @param docs. (probably bugref:9437)

Location:

trunk/src/VBox/HostServices/SharedClipboard

Files:

• VBoxSharedClipboardSvc-internal.h (modified) (6 diffs)
• VBoxSharedClipboardSvc-x11-stubs.cpp (modified) (7 diffs)
• VBoxSharedClipboardSvc-x11.cpp (modified) (6 diffs)
• VBoxSharedClipboardSvc.cpp (modified) (1 diff)

trunk/src/VBox/HostServices/SharedClipboard/VBoxSharedClipboardSvc-internal.h

@@ -308 +308 @@
  */
 int ShClBackendInit(void);
+
 /**
  * Called on destruction.
  */
 void ShClBackendDestroy(void);
+
 /**
  * Called when a new HGCM client connects.
@@ -320 +322 @@
  */
 int ShClBackendConnect(PSHCLCLIENT pClient, bool fHeadless);
+
 /**
  * Called when a HGCM client disconnects.
@@ -327 +330 @@
  */
 int ShClBackendDisconnect(PSHCLCLIENT pClient);
+
 /**
  * Called when the guest reported available clipboard formats to the host OS.
@@ -336 +340 @@
  */
 int ShClBackendFormatAnnounce(PSHCLCLIENT pClient, SHCLFORMATS fFormats);
-/** @todo Document: Can return VINF_HGCM_ASYNC_EXECUTE to defer returning read data.*/
+
 /**
  * Called when the guest wants to read host clipboard data.
@@ -347 +351 @@
  * @param   cbData              Size (in bytes) of buffer where to return the clipboard data.
  * @param   pcbActual           Where to return the amount of bytes read.
- */
-int ShClBackendReadData(PSHCLCLIENT pClient, PSHCLCLIENTCMDCTX pCmdCtx, SHCLFORMAT uFormat, void *pvData, uint32_t cbData, uint32_t *pcbActual);
+ *
+ * @todo    Document: Can return VINF_HGCM_ASYNC_EXECUTE to defer returning read
+ *          data
+ */
+int ShClBackendReadData(PSHCLCLIENT pClient, PSHCLCLIENTCMDCTX pCmdCtx, SHCLFORMAT uFormat,
+                        void *pvData, uint32_t cbData, uint32_t *pcbActual);
+
 /**
  * Called when the guest writes clipboard data to the host.
@@ -360 +369 @@
  */
 int ShClBackendWriteData(PSHCLCLIENT pClient, PSHCLCLIENTCMDCTX pCmdCtx, SHCLFORMAT uFormat, void *pvData, uint32_t cbData);
+
 /**
  * Called when synchronization of the clipboard contents of the host clipboard with the guest is needed.

trunk/src/VBox/HostServices/SharedClipboard/VBoxSharedClipboardSvc-x11-stubs.cpp

@@ -38 +38 @@
 
 
-/** Initialise the host side of the shared clipboard - called by the hgcm layer. */
+/*
+ * Initialise the host side of the shared clipboard - called by the hgcm layer.
+ */
 int ShClBackendInit(void)
 {
@@ -45 +47 @@
 }
 
-/** Terminate the host side of the shared clipboard - called by the hgcm layer. */
+/*
+ * Terminate the host side of the shared clipboard - called by the hgcm layer.
+ */
 void ShClBackendDestroy(void)
 {
@@ -51 +55 @@
 }
 
-/**
-  * Enable the shared clipboard - called by the hgcm clipboard subsystem.
-  *
-  * @returns RT status code
-  * @param   pClient            Structure containing context information about the guest system
-  * @param   fHeadless          Whether headless.
-  */
 int ShClBackendConnect(PSHCLCLIENT pClient, bool fHeadless)
 {
@@ -65 +62 @@
 }
 
-/**
+/*
  * Synchronise the contents of the host clipboard with the guest, called by the HGCM layer
  * after a save and restore of the guest.
@@ -76 +73 @@
 }
 
-/**
- * Shut down the shared clipboard subsystem and "disconnect" the guest.
- *
- * @param   pClient         Structure containing context information about the guest system
- */
 int ShClBackendDisconnect(PSHCLCLIENT pClient)
 {
@@ -87 +79 @@
 }
 
-/**
- * The guest is taking possession of the shared clipboard.  Called by the HGCM clipboard
- * subsystem.
- *
- * @param pClient               Context data for the guest system.
- * @param fFormats              Clipboard formats the guest is offering.
+/*
+ * The guest is taking possession of the shared clipboard.
+ * Called by the HGCM clipboard subsystem.
  */
 int ShClBackendFormatAnnounce(PSHCLCLIENT pClient, SHCLFORMATS fFormats)
@@ -100 +89 @@
 }
 
-/**
+/*
  * Called by the HGCM clipboard subsystem when the guest wants to read the host clipboard.
- *
- * @param pClient       Context information about the guest VM
- * @param pCmdCtx       Command context to use.
- * @param uFormat       Clipboard format to read.
- * @param pvData        Where to return the read clipboard data.
- * @param cbData        Size (in bytes) of buffer where to return the clipboard data.
- * @param pcbActual     Where to store the actual amount of data available.
  */
 int ShClBackendReadData(PSHCLCLIENT pClient, PSHCLCLIENTCMDCTX pCmdCtx,

trunk/src/VBox/HostServices/SharedClipboard/VBoxSharedClipboardSvc-x11.cpp

@@ -116 +116 @@
 }
 
-/**
+/*
  * Shut down the shared clipboard service and "disconnect" the guest.
- * @note  Host glue code
+ * Note!  Host glue code
  */
 int ShClBackendDisconnect(PSHCLCLIENT pClient)
@@ -173 +173 @@
  *         the backend code.
  */
-int ShClBackendReadData(PSHCLCLIENT pClient,
-                        PSHCLCLIENTCMDCTX pCmdCtx, SHCLFORMAT uFormat, void *pvData, uint32_t cbData, uint32_t *pcbActual)
+int ShClBackendReadData(PSHCLCLIENT pClient, PSHCLCLIENTCMDCTX pCmdCtx, SHCLFORMAT uFormat,
+                        void *pvData, uint32_t cbData, uint32_t *pcbActual)
 {
     AssertPtrReturn(pClient,   VERR_INVALID_POINTER);
@@ -237 +237 @@
 }
 
-int ShClBackendWriteData(PSHCLCLIENT pClient,
-                         PSHCLCLIENTCMDCTX pCmdCtx, SHCLFORMAT uFormat, void *pvData, uint32_t cbData)
+int ShClBackendWriteData(PSHCLCLIENT pClient, PSHCLCLIENTCMDCTX pCmdCtx, SHCLFORMAT uFormat, void *pvData, uint32_t cbData)
 {
     RT_NOREF(pClient, pCmdCtx, uFormat, pvData, cbData);
@@ -250 +249 @@
 }
 
-/** @copydoc ShClX11ReportFormatsCallback */
 DECLCALLBACK(void) ShClX11ReportFormatsCallback(PSHCLCONTEXT pCtx, uint32_t fFormats)
 {
@@ -272 +270 @@
 }
 
-/** @copydoc ShClX11RequestFromX11CompleteCallback */
 DECLCALLBACK(void) ShClX11RequestFromX11CompleteCallback(PSHCLCONTEXT pCtx, int rcCompletion,
                                                          CLIPREADCBREQ *pReq, void *pv, uint32_t cb)
@@ -309 +306 @@
 }
 
-/** @copydoc ShClX11RequestDataForX11Callback */
 DECLCALLBACK(int) ShClX11RequestDataForX11Callback(PSHCLCONTEXT pCtx, SHCLFORMAT uFmt, void **ppv, uint32_t *pcb)
 {

trunk/src/VBox/HostServices/SharedClipboard/VBoxSharedClipboardSvc.cpp

@@ -1695 +1695 @@
         rc = ShClBackendReadData(pClient, &cmdCtx, uFormat, pvData, cbData, &cbActual);
         if (RT_SUCCESS(rc))
-        {
             LogRel2(("Shared Clipboard: Read host clipboard data (max %RU32 bytes), got %RU32 bytes\n", cbData, cbActual));
-        }
         else
             LogRel(("Shared Clipboard: Reading host clipboard data failed with %Rrc\n", rc));