VirtualBox

Changeset 13005 in vbox


Ignore:
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.

Location:
trunk
Files:
29 edited

Legend:

Unmodified
Added
Removed

  • trunk/include/VBox/cpum.h

    r12989 r13005  
    3838__BEGIN_DECLS
    3939
    40 /** @defgroup grp_cpum      The CPU Monitor(/Manager) API
     40/** @defgroup grp_cpum      The CPU Monitor / Manager API
    4141 * @{
    4242 */

  • trunk/include/VBox/dbgf.h

    r12989 r13005  
    11/** @file
    2  * DBGF - Debugging Facility.
     2 * DBGF - Debugger Facility.
    33 */
    44
    … …  
    4141
    4242
    43 /** @defgroup grp_dbgf     The Debugging Facility API
     43/** @defgroup grp_dbgf     The Debugger Facility API
    4444 * @{
    4545 */

  • trunk/include/VBox/em.h

    r12989 r13005  
    3838__BEGIN_DECLS
    3939
    40 /** @defgroup grp_em        The Execution Monitor API
     40/** @defgroup grp_em        The Execution Monitor / Manager API
    4141 * @{
    4242 */

  • trunk/include/VBox/pdmasynccompletion.h

    r12989 r13005  
    3838__BEGIN_DECLS
    3939
    40 /** @defgroup grp_pdm_async_completion  Async I/O Completion
     40/** @defgroup grp_pdm_async_completion  The PDM Async I/O Completion API
    4141 * @ingroup grp_pdm
    4242 * @{

  • trunk/include/VBox/pdmasynctask.h

    r8155 r13005  
    3636
    3737
    38 /** @defgroup grp_pdm_async_task    Async Task
     38/** @defgroup grp_pdm_async_task    The PDM Async Task API
    3939 * @ingroup grp_pdm
    4040 * @{

  • trunk/include/VBox/pdmcritsect.h

    r12989 r13005  
    3636__BEGIN_DECLS
    3737
    38 /** @defgroup grp_pdm_critsect      The PDM Critical Section
     38/** @defgroup grp_pdm_critsect      The PDM Critical Section API
    3939 * @ingroup grp_pdm
    4040 * @{

  • trunk/include/VBox/pdmdev.h

    r12978 r13005  
    4848__BEGIN_DECLS
    4949
    50 /** @defgroup grp_pdm_device    Devices
     50/** @defgroup grp_pdm_device    The PDM Devices API
    5151 * @ingroup grp_pdm
    5252 * @{

  • trunk/include/VBox/pdmdrv.h

    r12989 r13005  
    5050__BEGIN_DECLS
    5151
    52 /** @defgroup grp_pdm_driver    Drivers
     52/** @defgroup grp_pdm_driver    The PDM Drivers API
    5353 * @ingroup grp_pdm
    5454 * @{

  • trunk/include/VBox/pdmifs.h

    r12518 r13005  
    3636__BEGIN_DECLS
    3737
    38 /** @defgroup grp_pdm_interfaces    Interfaces
     38/** @defgroup grp_pdm_interfaces    The PDM Interface Definitions
    3939 * @ingroup grp_pdm
    4040 * @{

  • trunk/include/VBox/pdmins.h

    r12970 r13005  
    3131#define ___VBox_pdmins_h
    3232
    33 /** @defgroup grp_pdm_ins       Common Instance Macros
     33/** @defgroup grp_pdm_ins       Common PDM Instance Macros
    3434 * @ingroup grp_pdm
    3535 * @{

  • trunk/include/VBox/pdmqueue.h

    r12989 r13005  
    3535__BEGIN_DECLS
    3636
    37 /** @defgroup grp_pdm_queue     Queues
     37/** @defgroup grp_pdm_queue     The PDM Queues API
    3838 * @ingroup grp_pdm
    3939 * @{

  • trunk/include/VBox/pdmsrv.h

    r8155 r13005  
    3737__BEGIN_DECLS
    3838
    39 /** @defgroup grp_pdm_services  Services
     39/** @defgroup grp_pdm_services  The PDM Services API
    4040 * @ingroup grp_pdm
    4141 * @{

  • trunk/include/VBox/pdmthread.h

    r12989 r13005  
    3939__BEGIN_DECLS
    4040
    41 /** @group grp_pdm_thread       Threads
     41/** @defgroup grp_pdm_thread    The PDM Threads API
    4242 * @ingroup grp_pdm
    4343 * @{

  • trunk/include/VBox/pdmusb.h

    r12989 r13005  
    4646__BEGIN_DECLS
    4747
    48 /** @defgroup grp_pdm_usbdev    USB Devices
     48/** @defgroup grp_pdm_usbdev    The USB Devices API
    4949 * @ingroup grp_pdm
    5050 * @{

  • trunk/include/VBox/pgm.h

    r12989 r13005  
    11/** @file
    2  * PGM - Page Monitor/Monitor.
     2 * PGM - Page Monitor / Monitor.
    33 */
    44
    … …  
    4040__BEGIN_DECLS
    4141
    42 /** @defgroup grp_pgm   The Page Monitor/Manager API
     42/** @defgroup grp_pgm   The Page Monitor / Manager API
    4343 * @{
    4444 */

  • trunk/include/VBox/tm.h

    r12989 r13005  
    11/** @file
    2  * TM - Time Monitor.
     2 * TM - Time Manager.
    33 */
    44
    … …  
    3939__BEGIN_DECLS
    4040
    41 /** @defgroup grp_tm        The Time Monitor API
     41/** @defgroup grp_tm        The Time Manager API
    4242 * @{
    4343 */

  • trunk/src/VBox/VMM/CFGM.cpp

    r12989 r13005  
    4141 * caller is in a better position to know the proper validation rules of the
    4242 * individual properties.
     43 *
     44 * @see grp_cfgm
    4345 *
    4446 *

  • trunk/src/VBox/VMM/CPUM.cpp

    r12989 r13005  
    3232 * registers accross world switches. This latter is done in cooperation with the
    3333 * world switcher (@see pg_vmm).
     34 *
     35 * @see grp_cpum
    3436 */
    3537

  • trunk/src/VBox/VMM/DBGF.cpp

    r12989 r13005  
    3838 * from the use of the Ping-Pong synchronization construct from the RTSem API.)
    3939 *
     40 * @see grp_dbgf
    4041 *
    4142 *

  • trunk/src/VBox/VMM/EM.cpp

    r12989 r13005  
    11/* $Id$ */
    22/** @file
    3  * EM - Execution Monitor/Manager.
     3 * EM - Execution Monitor / Manager.
    44 */
    55
    … …  
    2020 */
    2121
    22 /** @page pg_em         EM - The Execution Monitor/Manager
     22/** @page pg_em         EM - The Execution Monitor / Manager
    2323 *
    2424 * The Execution Monitor/Manager is responsible for running the VM, scheduling
    … …  
    3232 * raw-mode/hwaccm and the recompiler when fielding virtualization traps/faults.
    3333 * The interpretation is thus implemented as part of EM.
     34 *
     35 * @see grp_em
    3436 */
    3537

  • trunk/src/VBox/VMM/IOM.cpp

    r12989 r13005  
    2727 * I/0 port handlers and memory mapped I/O handlers. A handler is PDM devices
    2828 * and a set of callback functions.
     29 *
     30 * @see grp_iom
    2931 *
    3032 *

  • trunk/src/VBox/VMM/MM.cpp

    r12989 r13005  
    3434 * MM will provide therefore ring-3 callable interfaces for some of the GMM APIs
    3535 * related to resource tracking (PGM is the user).
     36 *
     37 * @see grp_mm
    3638 *
    3739 *

  • trunk/src/VBox/VMM/PDM.cpp

    r12989 r13005  
    3333 * context synchronization (like critsect), VM centric thread management,
    3434 * asynchronous I/O framework, and so on.
     35 *
     36 * @see grp_pdm
    3537 *
    3638 *
    … …  
    9294 * since the address changes when RC is relocated.
    9395 *
     96 * @see grp_pdm_device
    9497 *
    9598 *
    … …  
    109112 * devices/functions.
    110113 *
     114 * @see grp_pdm_usbdev
    111115 *
    112116 *
    … …  
    143147 * 'VBoxDriversRegister' with a callback table.
    144148 *
     149 * @see grp_pdm_driver
    145150 *
    146151 *
    … …  
    159164 * been better done in C++.)
    160165 *
     166 * @see grp_pdm_interfaces
    161167 *
    162168 *
    … …  
    171177 *
    172178 *
    173  * @subsection sec_pdm_thread       Async I/O
     179 * @subsection sec_pdm_async_completion     Async I/O
    174180 *
    175181 * The PDM Async I/O API provides a somewhat platform agnostic interface for
    … …  
    179185 * @todo more details.
    180186 *
    181  *
    182  * @subsection sec_pdm_thread       Critical Section
     187 * @see grp_pdm_async_completion
     188 *
     189 *
     190 * @subsection sec_pdm_async_task   Async Task - not implemented
     191 *
     192 * @todo implement and describe
     193 *
     194 * @see grp_pdm_async_task
     195 *
     196 *
     197 * @subsection sec_pdm_critsect     Critical Section
    183198 *
    184199 * The PDM Critical Section API is currently building on the IPRT API with the
    … …  
    192207 * efficient. (Raw-mode won't benefit much from this, naturally.)
    193208 *
    194  *
    195  * @subsection sec_pdm_thread       Queue
     209 * @see grp_pdm_critsect
     210 *
     211 *
     212 * @subsection sec_pdm_queue        Queue
    196213 *
    197214 * The PDM Queue API is for queuing one or more tasks for later consumption in
    … …  
    203220 * send work / events over to the EMT.
    204221 *
    205  *
    206  * @subsection sec_pdm_thread       Task - not implemented yet
     222 * @see grp_pdm_queue
     223 *
     224 *
     225 * @subsection sec_pdm_task        Task - not implemented yet
    207226 *
    208227 * The PDM Task API is for flagging a task for execution at a later point when
    … …  
    212231 * A task can also be scheduled by another thread (a I/O worker for instance) as
    213232 * a mean of getting something done in EMT.
     233 *
     234 * @see grp_pdm_task
    214235 *
    215236 *
    … …  
    224245 * VM is paused can cause the state to change during saving or have other
    225246 * unwanted side effects. The PDM Threads API ensures that this won't happen.
     247 *
     248 * @see grp_pdm_thread
    226249 *
    227250 */

  • trunk/src/VBox/VMM/PGM.cpp

    r13001 r13005  
    2323/** @page pg_pgm PGM - The Page Manager and Monitor
    2424 *
    25  * See also @ref pg_pgmPhys, @ref pg_pgm_pool.
     25 * @see grp_pgm,
     26 * @ref pg_pgm_pool,
     27 * @ref pg_pgm_phys.
    2628 *
    2729 *
    … …  
    200202
    201203
    202 /** @page pg_pgmPhys PGMPhys - Physical Guest Memory Management.
     204/** @page pg_pgm_phys   PGM Physical Guest Memory Management
    203205 *
    204206 *

  • trunk/src/VBox/VMM/SELM.cpp

    r13001 r13005  
    2424 * Manages the hypervisor GDT entires, monitors and shadows the guest GDT, LDT
    2525 * and TSS. Only active in raw-mode.
     26 *
     27 * @see grp_selm
    2628 *
    2729 */

  • trunk/src/VBox/VMM/SSM.cpp

    r12989 r13005  
    3535 *
    3636 * The SSM provides a number of APIs for encoding and decoding the data.
     37 *
     38 * @see grp_ssm
    3739 */
    3840

  • trunk/src/VBox/VMM/STAM.cpp

    r13001 r13005  
    3232 * components separated by slashes ('/').
    3333 *
    34  */
    35 
     34 * @see grp_stam
     35 */
    3636
    3737/*******************************************************************************

  • trunk/src/VBox/VMM/TM.cpp

    r12989 r13005  
    11/* $Id$ */
    22/** @file
    3  * TM - Timeout Manager.
     3 * TM - Time Manager.
    44 */
    55
    … …  
    2525 * The Time Manager abstracts the CPU clocks and manages timers used by the VMM,
    2626 * device and drivers.
     27 *
     28 * @see grp_tm
    2729 *
    2830 *

  • trunk/src/VBox/VMM/VMM.cpp

    r12975 r13005  
    7777 *        debugging the alternate reality execution.
    7878 *
     79 *
     80 * @see grp_vmm, grp_vm
    7981 *
    8082 *
Note: See TracChangeset for help on using the changeset viewer.

© 2025 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette