Changeset 102823 in vbox for trunk/src

Timestamp:

Jan 10, 2024 5:15:58 PM (13 months ago)

Author:

vboxsync

Message:

Shared Clipboard/X11: Docs fixes. bugref:9437

File:

• trunk/src/VBox/GuestHost/SharedClipboard/clipboard-x11.cpp (modified) (3 diffs)

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

@@ -1482 +1482 @@
 
 /**
- * Helper for ShClX11RequestDataForX11Callback() that will cache the data returned.
+ * Helper for clipConvertToX11Data() that will cache the data returned.
  *
  * @returns VBox status code. VERR_NO_DATA if no data available.
@@ -1979 +1979 @@
  * @param   pCtx                Context data for the clipboard backend.
  * @param   uFormats            Clipboard formats offered.
+ *
+ * @note    When calling this function, data for the clipboard already has to be available,
+ *          as we grab the clipboard, which in turn then calls the X11 data conversion callback.
  */
 int ShClX11ReportFormatsToX11Async(PSHCLX11CTX pCtx, SHCLFORMATS uFormats)
@@ -2524 +2527 @@
  * Worker function for ShClX11ReadDataFromX11Async.
  *
- * @param  pvUserData           Pointer to a CLIPREADX11CBREQ structure containing
+ * @param  pvUserData           Pointer to a PSHCLX11REQUEST structure containing
  *                              information about the clipboard read request.
  *                              Must be free'd by the worker.