VirtualBox

source: vbox/trunk/doc/VBox-doc.c@ 24547

Last change on this file since 24547 was 13001, checked in by vboxsync, 16 years ago

VBox-doc.c,VMM: doxygen links

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 4.0 KB
Line 
1/* $Id: VBox-doc.c 13001 2008-10-06 11:06:14Z vboxsync $ */
2/** @file
3 * VirtualBox Top Level Documentation File.
4 */
5
6/*
7 * Copyright (C) 2006-2007 Sun Microsystems, Inc.
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.org. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 *
17 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
18 * Clara, CA 95054 USA or visit http://www.sun.com if you need
19 * additional information or have any questions.
20 */
21
22
23/** @mainpage VirtualBox
24 *
25 * (add introduction here)
26 *
27 * @section pg_main_comp Components
28 *
29 * - VM / @ref pg_vmm "VMM" / GVM / @ref pg_gvmm "GVMM" - Virtual Machine
30 * Monitor.
31 * - @ref pg_cfgm
32 * - @ref pg_cpum
33 * - CSAM - Guest OS Code Scanning and Analyis Manager.
34 * - @ref pg_dbgf
35 * - DBGC - Debugger Console.
36 * - VBoxDbg - Debugger GUI (Qt).
37 * - DIS - Disassembler.
38 * - @ref pg_em
39 * - HWACCM - Intel/AMD VM Hardware Support Manager.
40 * - REM - Recompiled Execution Monitor.
41 * - @ref pg_gmm
42 * - @ref pg_mm
43 * - @ref pg_pgm
44 * - @ref pg_selm
45 * - @ref pg_iom
46 * - PATM - Dynamic Guest OS Patching Manager.
47 * - @ref pg_pdm
48 * - Devices / USB Devices, Drivers and their public interfaces.
49 * - Async I/O Completion API.
50 * - Async Task API.
51 * - Critical Section API.
52 * - Queue API.
53 * - Thread API.
54 * - @ref pg_ssm
55 * - @ref pg_stam
56 * - @ref pg_tm
57 * - @ref pg_trpm
58 * - Pluggable Components (via PDM).
59 * - DevPCArch - PC Architecture Device (chipset, legacy ++).
60 * - DevPCBios - Basic Input Output System.
61 * - DevDMAC - DMA Controller.
62 * - DevPIC - Programmable Interrupt Controller.
63 * - DevPIT - Programmable Interval Timer (i8254).
64 * - DevRTC - Real Time Clock.
65 * - DevVGA - Video Graphic Array.
66 * - DevPCI - Peripheral Component Interface (Bus).
67 * - VBoxDev - Special PCI Device which serves as an interface between
68 * the VMM and the guest OS for the additions.
69 * - Networking:
70 * - DevPCNet - AMD PCNet Device Emulation.
71 * - DevE1000 - Intel E1000 Device Emulation.
72 * - DevEEPROM - Intel E1000 EPROM Device Emulation.
73 * - SrvINetNetR0 - Internal Networking Ring-0 Service.
74 * - DevINIP - IP Stack Service for the internal networking.
75 * - DrvIntNet - Internal Networking Driver.
76 * - DrvNetSniffer - Wireshark Compatible Sniffer Driver (pass thru).
77 * - DrvNAT - Network Address Translation Driver.
78 * - DrvTAP - Host Interface Networking Driver.
79 * - Storage:
80 * - DevATA - ATA ((E)IDE) Device Emulation.
81 * - DevAHCI - Serial ATA / AHCI Device Emulation.
82 * - DevFDC - Floppy Controller Device Emulation.
83 * - DrvBlock - Intermediate block driver.
84 * - DrvHostBase - Common code for the host drivers.
85 * - DrvHostDVD - Host DVD drive driver.
86 * - DrvHostFloppy - Host floppy drive driver.
87 * - DrvHostRawDisk - Host raw disk drive driver.
88 * - DrvMediaISO - ISO media driver.
89 * - DrvRawImage - Raw image driver (floppy images etc).
90 * - DrvVD - Intermediate Virtual Drive (Media) driver.
91 * - DrvVDI - VirtualBox Drive Image Container Driver.
92 * - DrvVmdk - VMDK Drive Image Container Driver.
93 * - Host Drivers.
94 * - SUPDRV - The Support driver (aka VBoxDrv).
95 * - VBoxUSB - The USB support driver.
96 * - VBoxTAP - The Host Interface Networking driver.
97 * - @ref pg_netflt
98 * - Host Services.
99 * - Shared Clipboard.
100 * - 3D
101 * - Main API.
102 *
103 * @todo Make links to the components.
104 */
105
Note: See TracBrowser for help on using the repository browser.

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