Changeset 65123 in vbox

Timestamp:

Jan 4, 2017 5:11:32 PM (8 years ago)

Author:

vboxsync

Message:

HostServices: doxygen fixes

Location:

trunk/src/VBox/HostServices

Files:

• SharedClipboard/VBoxClipboard-win.cpp (modified) (2 diffs)
• SharedClipboard/darwin.cpp (modified) (1 diff)
• SharedClipboard/x11-clipboard.cpp (modified) (1 diff)
• SharedClipboard/x11-stub.cpp (modified) (5 diffs)
• SharedFolders/vbsf.cpp (modified) (3 diffs)
• SharedFolders/vbsfpath.h (modified) (2 diffs)

trunk/src/VBox/HostServices/SharedClipboard/VBoxClipboard-win.cpp

@@ -790 +790 @@
 }
 
-int vboxClipboardConnect (VBOXCLIPBOARDCLIENTDATA *pClient, bool)
-{
+int vboxClipboardConnect (VBOXCLIPBOARDCLIENTDATA *pClient, bool fHeadless)
+{
+    NOREF(fHeadless);
     Log(("vboxClipboardConnect\n"));
 
@@ -1047 +1048 @@
  * Check that the source string contains CF_HTML struct
  *
- * @returns @c true if the @source string is in CF_HTML format
+ * @param   pszSource   source string.
+ *
+ * @returns @c true if the @a pszSource string is in CF_HTML format
  */
 static bool IsWindowsHTML(const char *pszSource)

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

@@ -151 +151 @@
  *
  * @param   pClient Structure containing context information about the guest system
+ * @param   fHeadless Whether headless.
  * @returns RT status code
  */
-int vboxClipboardConnect (VBOXCLIPBOARDCLIENTDATA *pClient, bool)
-{
+int vboxClipboardConnect (VBOXCLIPBOARDCLIENTDATA *pClient, bool fHeadless)
+{
+    NOREF(fHeadless);
     if (g_ctx.pClient != NULL)
     {

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

@@ -250 +250 @@
  * @param  pCtx  request context information
  * @param  rc    the completion status of the request
- * @param  cbActual  on successful completion, the number of bytes of data
- *                   actually written, on buffer overflow the size of the
- *                   buffer needed, ignored otherwise
+ * @param  pReq  request
+ * @param  pv    address
+ * @param  cb    size
+ *
  * @todo   change this to deal with the buffer issues rather than offloading
  *         them onto the caller
  */
 void ClipCompleteDataRequestFromX11(VBOXCLIPBOARDCONTEXT *pCtx, int rc,
-                                    CLIPREADCBREQ *pReq, void *pv,
-                                    uint32_t cb)
+                                    CLIPREADCBREQ *pReq, void *pv, uint32_t cb)
 {
     if (cb <= pReq->cb)

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

@@ -49 +49 @@
   * Enable the shared clipboard - called by the hgcm clipboard subsystem.
   *
-  * @param   pClient Structure containing context information about the guest system
+  * @param   pClient    Structure containing context information about the guest system
+  * @param   fHeadless  Whether headless.
   * @returns RT status code
   */
-int vboxClipboardConnect (VBOXCLIPBOARDCLIENTDATA * /* pClient */,
-                          bool /* fHeadless */)
+int vboxClipboardConnect (VBOXCLIPBOARDCLIENTDATA *pClient,
+                          bool fHeadless)
 {
+    NOREF(pClient, fHeadless);
     LogFlowFunc(("called, returning VINF_SUCCESS.\n"));
     return VINF_SUCCESS;
@@ -71 +73 @@
 /**
  * Shut down the shared clipboard subsystem and "disconnect" the guest.
+ * 
+ * @param   pClient    Structure containing context information about the guest system
  */
-void vboxClipboardDisconnect (VBOXCLIPBOARDCLIENTDATA * /* pClient */)
+void vboxClipboardDisconnect (VBOXCLIPBOARDCLIENTDATA *pClient)
 {
+    NOREF(pClient);
     LogFlowFunc(("called, returning.\n"));
 }
@@ -84 +89 @@
  * @param u32Formats Clipboard formats the guest is offering
  */
-void vboxClipboardFormatAnnounce (VBOXCLIPBOARDCLIENTDATA * /* pClient */,
-                                  uint32_t /* u32Formats */)
+void vboxClipboardFormatAnnounce (VBOXCLIPBOARDCLIENTDATA *pClient,
+                                  uint32_t u32Formats)
 {
+    NOREF(pClient, u32Formats);
     LogFlowFunc(("called, returning.\n"));
 }
@@ -99 +105 @@
  * @param pcbActual Where to write the actual size of the written data
  */
-int vboxClipboardReadData (VBOXCLIPBOARDCLIENTDATA * /* pClient */, uint32_t /* u32Format */,
-                           void * /* pv */, uint32_t /* cb */, uint32_t * pcbActual)
+int vboxClipboardReadData (VBOXCLIPBOARDCLIENTDATA *pClient, uint32_t u32Format,
+                           void *pv, uint32_t cb, uint32_t *pcbActual)
 {
+    NOREF(pClient, u32Format, pv, cb);
     LogFlowFunc(("called, returning VINF_SUCCESS.\n"));
     /* No data available. */
@@ -116 +123 @@
  * @param u32Format The format of the data written
  */
-void vboxClipboardWriteData (VBOXCLIPBOARDCLIENTDATA * /* pClient */, void * /* pv */,
-                             uint32_t /* cb */, uint32_t /* u32Format */)
+void vboxClipboardWriteData (VBOXCLIPBOARDCLIENTDATA *pClient, void *pv,
+                             uint32_t cb, uint32_t u32Format)
 {
+    NOREF(pClient, pv, cb, u32Format);
     LogFlowFunc(("called, returning.\n"));
 }

trunk/src/VBox/HostServices/SharedFolders/vbsf.cpp

@@ -149 +149 @@
  * @param  fShflFlags shared folder create flags
  * @param  fMode      file attributes
+ * @param  handleInitial initial handle
  * @retval pfOpen     iprt create flags
  */
@@ -700 +701 @@
  *
  * @returns iprt status code (currently VINF_SUCCESS)
- * @param   pszFullPath    The path of the file to be looked up
+ * @param   pClient    client data
+ * @param   pszPath    The path of the file to be looked up
  * @retval  pParms->Result Status of the operation (success or error)
  * @retval  pParms->Info   On success, information returned about the file
@@ -757 +759 @@
 }
 #endif
+
 /**
  * Create or open a file or folder.  Perform character set and case

trunk/src/VBox/HostServices/SharedFolders/vbsfpath.h

@@ -37 +37 @@
  * @param ppszHostPath           Returned full host path: root prefix + guest path.
  * @param pcbHostPathRoot        Length of the root prefix in bytes. Optional, can be NULL.
- * @param fWildCard              Whether the last component may contain
- *                               wildcards and thus might require exclusion
- *                               from the case correction.
- * @param fPreserveLastComponent Always exclude the last component from case
- *                               correction if set.
+ * @param fu32Options            Options.
  * @param pfu32PathFlags         VBSF_F_PATH_* flags. Optional, can be NULL.
  */
@@ -47 +43 @@
                         PSHFLSTRING pGuestString, uint32_t cbGuestString,
                         char **ppszHostPath, uint32_t *pcbHostPathRoot,
-                        uint32_t fu32Options,
-                        uint32_t *pfu32PathFlags);
+                        uint32_t fu32Options, uint32_t *pfu32PathFlags);
 
 /** Free the host path returned by vbsfPathGuestToHost.