Changeset 80459 in vbox

Timestamp:

Aug 28, 2019 8:34:32 AM (6 years ago)

Author:

vboxsync

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

132950

Message:

Shared Clipboard/URI: Docs.

Location:

trunk

Files:

trunk/include/VBox/GuestHost/SharedClipboard-uri.h

-              r80444
+              r80459
 } VBOXCLIPBOARDLIST, *PVBOXCLIPBOARDLIST;
+/**
+ * Structure for keeping a Shared Clipboard object data chunk.
+ */
 typedef struct _VBOXCLIPBOARDOBJDATACHUNK
+{
+    /** Handle of object this data chunk is related to. */
     uint64_t  uHandle;
+    /** Pointer to actual data chunk. */
     void     *pvData;
+    /** Size (in bytes) of data chunk. */
     uint32_t  cbData;
 } VBOXCLIPBOARDOBJDATACHUNK, *PVBOXCLIPBOARDOBJDATACHUNK;

-              r80444
+              r80459
+}
+/**
+ * Creates (initializes) an event.
+ *
+ * @returns VBox status code.
+ * @param   pEvent              Event to initialize.
+ * @param   uID                 ID to use for the event.
+ */
 int SharedClipboardEventCreate(PSHAREDCLIPBOARDEVENT pEvent, uint16_t uID)
+{
 …
+}
+/**
+ * Destroys an event.
+ *
+ * @param   pEvent              Event to destroy.
+ */
 void SharedClipboardEventDestroy(PSHAREDCLIPBOARDEVENT pEvent)
+{
 …
+}
+/**
+ * Creates a new event source.
+ *
+ * @returns VBox status code.
+ * @param   pSource             Event source to create.
+ * @param   uID                 ID to use for event source.
+ */
 int SharedClipboardEventSourceCreate(PSHAREDCLIPBOARDEVENTSOURCE pSource, uint16_t uID)
+{
 …
+}
+/**
+ * Destroys an event source.
+ *
+ * @param   pSource             Event source to destroy.
+ */
 void SharedClipboardEventSourceDestroy(PSHAREDCLIPBOARDEVENTSOURCE pSource)
+{

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