Changeset 13001 in vbox

Timestamp:

Oct 6, 2008 11:06:14 AM (17 years ago)

Author:

vboxsync

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

37439

Message:

VBox-doc.c,VMM: doxygen links

Location:

trunk

Files:

• doc/VBox-doc.c (modified) (3 diffs)
• src/VBox/VMM/PGM.cpp (modified) (1 diff)
• src/VBox/VMM/SELM.cpp (modified) (1 diff)
• src/VBox/VMM/STAM.cpp (modified) (1 diff)
• src/VBox/VMM/VMMR0/GVMMR0.cpp (modified) (1 diff)

trunk/doc/VBox-doc.c

@@ -27 +27 @@
  * @section pg_main_comp    Components
  *
- *  - VM / VMM / GVM / GVMM - Virtual Machine Monitor.
- *      - CFGM - Configuration Manager.
- *      - CPUM - CPU Monitor.
+ *  - VM / @ref pg_vmm "VMM" / GVM / @ref pg_gvmm "GVMM" - Virtual Machine
+ *    Monitor.
+ *      - @ref pg_cfgm
+ *      - @ref pg_cpum
  *      - CSAM - Guest OS Code Scanning and Analyis Manager.
- *      - DBGF - Debugging Facility.
+ *      - @ref pg_dbgf
  *          - DBGC - Debugger Console.
  *          - VBoxDbg - Debugger GUI (Qt).
  *      - DIS - Disassembler.
- *      - EM - Excution Monitor.
+ *      - @ref pg_em
  *      - HWACCM - Intel/AMD VM Hardware Support Manager.
  *      - REM - Recompiled Execution Monitor.
- *      - GMM - Global Memory Manager.
- *          - MM - Memory Monitor.
- *          - PGM - Page Monitor
- *          - SELM - Selector Monitor
- *      - IOM - Input / Output Monitor.
+ *      - @ref pg_gmm
+ *          - @ref pg_mm
+ *          - @ref pg_pgm
+ *          - @ref pg_selm
+ *      - @ref pg_iom
  *      - PATM - Dynamic Guest OS Patching Manager.
- *      - PDM  - Pluggable Device Manager.
+ *      - @ref pg_pdm
  *          - Devices / USB Devices, Drivers and their public interfaces.
  *          - Async I/O Completion API.
@@ -51 +52 @@
  *          - Queue API.
  *          - Thread API.
- *      - SSM - Save State Manager.
- *      - STAM - Statistics Manager.
- *      - TM - Time Monitor.
- *      - TRPM - Trap & Interrupt Monitor
+ *      - @ref pg_ssm
+ *      - @ref pg_stam
+ *      - @ref pg_tm
+ *      - @ref pg_trpm
  *  - Pluggable Components (via PDM).
  *      - DevPCArch - PC Architecture Device (chipset, legacy ++).
@@ -94 +95 @@
  *      - VBoxUSB - The USB support driver.
  *      - VBoxTAP - The Host Interface Networking driver.
+ *      - @ref pg_netflt
  *  - Host Services.
  *      - Shared Clipboard.

trunk/src/VBox/VMM/PGM.cpp

@@ -23 +23 @@
 /** @page pg_pgm PGM - The Page Manager and Monitor
  *
+ * See also @ref pg_pgmPhys, @ref pg_pgm_pool.
  *
  *

trunk/src/VBox/VMM/SELM.cpp

@@ -18 +18 @@
  * Clara, CA 95054 USA or visit http://www.sun.com if you need
  * additional information or have any questions.
+ */
+
+/** @page pg_selm   SELM - The Selector Manager
+ *
+ * Manages the hypervisor GDT entires, monitors and shadows the guest GDT, LDT
+ * and TSS. Only active in raw-mode.
+ *
  */
 

trunk/src/VBox/VMM/STAM.cpp

@@ -18 +18 @@
  * Clara, CA 95054 USA or visit http://www.sun.com if you need
  * additional information or have any questions.
+ */
+
+/** @page pg_stam       STAM - The Statistics Manager
+ *
+ * The purpose for the statistics manager is to present the rest of the system
+ * with a somewhat uniform way of accessing VMM statistics. STAM sports a couple
+ * of different APIs for accessing them: STAMR3EnumU, STAMR3SnapshotU,
+ * STAMR3DumpU, STAMR3DumpToReleaseLogU. Main is exposing the XML based one,
+ * STAMR3SnapshotU.
+ *
+ * The rest of the VMM together with the devices and drivers registers their
+ * statistics with STAM giving them a name. The name is like hierarchical, the
+ * components separated by slashes ('/').
+ *
  */
 

trunk/src/VBox/VMM/VMMR0/GVMMR0.cpp

@@ -21 +21 @@
 
 
-/** @page pg_GVMM   GVMM - The Global VM Manager
+/** @page pg_gvmm   GVMM - The Global VM Manager
  *
  * The Global VM Manager lives in ring-0. It's main function at the moment