Changeset 13005 in vbox for trunk/src/VBox/VMM/PDM.cpp

Timestamp:

Oct 6, 2008 12:35:21 PM (17 years ago)

Author:

vboxsync

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

37443

Message:

VMM/doxygen: More links.

File:

• trunk/src/VBox/VMM/PDM.cpp (modified) (11 diffs)

trunk/src/VBox/VMM/PDM.cpp

@@ -33 +33 @@
  * context synchronization (like critsect), VM centric thread management,
  * asynchronous I/O framework, and so on.
+ *
+ * @see grp_pdm
  *
  *
@@ -92 +94 @@
  * since the address changes when RC is relocated.
  *
+ * @see grp_pdm_device
  *
  *
@@ -109 +112 @@
  * devices/functions.
  *
+ * @see grp_pdm_usbdev
  *
  *
@@ -143 +147 @@
  * 'VBoxDriversRegister' with a callback table.
  *
+ * @see grp_pdm_driver
  *
  *
@@ -159 +164 @@
  * been better done in C++.)
  *
+ * @see grp_pdm_interfaces
  *
  *
@@ -171 +177 @@
  *
  *
- * @subsection sec_pdm_thread       Async I/O
+ * @subsection sec_pdm_async_completion     Async I/O
  *
  * The PDM Async I/O API provides a somewhat platform agnostic interface for
@@ -179 +185 @@
  * @todo more details.
  *
- *
- * @subsection sec_pdm_thread       Critical Section
+ * @see grp_pdm_async_completion
+ *
+ *
+ * @subsection sec_pdm_async_task   Async Task - not implemented
+ *
+ * @todo implement and describe
+ *
+ * @see grp_pdm_async_task
+ *
+ *
+ * @subsection sec_pdm_critsect     Critical Section
  *
  * The PDM Critical Section API is currently building on the IPRT API with the
@@ -192 +207 @@
  * efficient. (Raw-mode won't benefit much from this, naturally.)
  *
- *
- * @subsection sec_pdm_thread       Queue
+ * @see grp_pdm_critsect
+ *
+ *
+ * @subsection sec_pdm_queue        Queue
  *
  * The PDM Queue API is for queuing one or more tasks for later consumption in
@@ -203 +220 @@
  * send work / events over to the EMT.
  *
- *
- * @subsection sec_pdm_thread       Task - not implemented yet
+ * @see grp_pdm_queue
+ *
+ *
+ * @subsection sec_pdm_task        Task - not implemented yet
  *
  * The PDM Task API is for flagging a task for execution at a later point when
@@ -212 +231 @@
  * A task can also be scheduled by another thread (a I/O worker for instance) as
  * a mean of getting something done in EMT.
+ *
+ * @see grp_pdm_task
  *
  *
@@ -224 +245 @@
  * VM is paused can cause the state to change during saving or have other
  * unwanted side effects. The PDM Threads API ensures that this won't happen.
+ *
+ * @see grp_pdm_thread
  *
  */