Changeset 21217 in vbox for trunk/include

Timestamp:

Jul 4, 2009 2:26:39 PM (16 years ago)

Author:

vboxsync

Message:

include/VBox/*.h: Mark which components the header files relate to.

Location:

trunk/include/VBox

Files:

: 65 edited

DevPCNet.h (modified) (1 diff)
VBoxDev.h (modified) (1 diff)
VBoxGuest.h (modified) (1 diff)
VBoxVideo.h (modified) (1 diff)
VRDPAuth.h (modified) (1 diff)
VRDPOrders.h (modified) (1 diff)
bioslogo.h (modified) (1 diff)
cfgm.h (modified) (1 diff)
cpum.h (modified) (1 diff)
cpumdis.h (modified) (1 diff)
csam.h (modified) (1 diff)
dbg.h (modified) (1 diff)
dbgf.h (modified) (1 diff)
dbgfsel.h (modified) (1 diff)
dbggui.h (modified) (1 diff)
em.h (modified) (1 diff)
gmm.h (modified) (1 diff)
gvm.h (modified) (1 diff)
gvmm.h (modified) (1 diff)
hgcmsvc.h (modified) (3 diffs)
hwacc_svm.h (modified) (1 diff)
hwacc_vmx.h (modified) (1 diff)
hwaccm.h (modified) (1 diff)
intnet.h (modified) (1 diff)
iom.h (modified) (1 diff)
mm.h (modified) (1 diff)
param.h (modified) (1 diff)
patm.h (modified) (1 diff)
pci.h (modified) (1 diff)
pdm.h (modified) (1 diff)
pdmapi.h (modified) (1 diff)
pdmasynccompletion.h (modified) (1 diff)
pdmasynctask.h (modified) (1 diff)
pdmcritsect.h (modified) (1 diff)
pdmdev.h (modified) (1 diff)
pdmdrv.h (modified) (1 diff)
pdmifs.h (modified) (1 diff)
pdmins.h (modified) (1 diff)
pdmqueue.h (modified) (1 diff)
pdmsrv.h (modified) (1 diff)
pdmthread.h (modified) (1 diff)
pdmusb.h (modified) (1 diff)
pgm.h (modified) (1 diff)
rem.h (modified) (1 diff)
scsi.h (modified) (1 diff)
selm.h (modified) (1 diff)
settings.h (modified) (1 diff)
shflsvc.h (modified) (3 diffs)
ssm.h (modified) (1 diff)
stam.h (modified) (1 diff)
sup.h (modified) (1 diff)
tm.h (modified) (1 diff)
trpm.h (modified) (1 diff)
usb.h (modified) (1 diff)
usblib-win.h (modified) (1 diff)
usblib.h (modified) (1 diff)
uvm.h (modified) (1 diff)
version.h (modified) (2 diffs)
vm.h (modified) (1 diff)
vmapi.h (modified) (1 diff)
vmm.h (modified) (1 diff)
vrdpapi.h (modified) (1 diff)
vrdpusb.h (modified) (1 diff)
vusb.h (modified) (1 diff)
x86.h (modified) (1 diff)

Legend:

: Unmodified
: Added
: Removed

trunk/include/VBox/DevPCNet.h

r8155	r21217
1	1	/** @file
2		* DevPCNet - Private guest interface for the PCNet device.
	2	* DevPCNet - Private guest interface for the PCNet device. (DEV)
3	3	*/
4	4

trunk/include/VBox/VBoxDev.h

r20374	r21217
1	1	/** @file
2		* Virtual Device for Guest <-> VMM/Host communication
	2	* Virtual Device for Guest <-> VMM/Host communication (ADD,DEV).
3	3	*/
4	4

trunk/include/VBox/VBoxGuest.h

r21212	r21217
1	1	/** @file
2		* VBoxGuest - VirtualBox Guest Additions Driver Interface.
	2	* VBoxGuest - VirtualBox Guest Additions Driver Interface. (ADD,DEV)
3	3	*/
4	4

trunk/include/VBox/VBoxVideo.h

r20985	r21217
1	1	/** @file
2		* VirtualBox Video interface
	2	* VirtualBox Video interface.
3	3	*/
4	4

trunk/include/VBox/VRDPAuth.h

-              r11961
+              r21217
 /** @file
  * VBox Remote Desktop Protocol:
  * External Authentication Library Interface.
+ * VBox Remote Desktop Protocol - External Authentication Library Interface.
+ * (VRDP)
  */

trunk/include/VBox/VRDPOrders.h

r8155	r21217
1	1	/** @file
2		* VBox Remote Desktop Protocol:
3		* VRDP orders structures.
	2	* VBox Remote Desktop Protocol - Orders Structures. (VRDP)
4	3	*/
5	4

trunk/include/VBox/bioslogo.h

r8155	r21217
1	1	/* $Id$ */
2	2	/** @file
3		* BiosLogo - The Private BIOS Logo Interface.
	3	* BiosLogo - The Private BIOS Logo Interface. (DEV)
4	4	*/
5	5

trunk/include/VBox/cfgm.h

r20374	r21217
1	1	/** @file
2		* CFGM - Configuration Manager.
	2	* CFGM - Configuration Manager. (VMM)
3	3	*/
4	4

trunk/include/VBox/cpum.h

r20374	r21217
1	1	/** @file
2		* CPUM - CPU Monitor(/ Manager).
	2	* CPUM - CPU Monitor(/ Manager). (VMM)
3	3	*/
4	4

trunk/include/VBox/cpumdis.h

r20374	r21217
1	1	/** @file
2		* CPUM - ~~CPU Monitor(/Manager~~)
	2	* CPUM - Disassembler. (VMM)
3	3	*/
4	4

trunk/include/VBox/csam.h

r20374	r21217
1	1	/** @file
2		* CSAM - Guest OS Code Scanning and Analyis Manager.
	2	* CSAM - Guest OS Code Scanning and Analyis Manager. (VMM)
3	3	*/
4	4

trunk/include/VBox/dbg.h

r20374	r21217
1	1	/** @file
2		* Debugger Interfaces.
	2	* Debugger Interfaces. (VBoxDbg)
3	3	*
4	4	* This header covers all external interfaces of the Debugger module.

trunk/include/VBox/dbgf.h

r21111	r21217
1	1	/** @file
2		* DBGF - Debugger Facility.
	2	* DBGF - Debugger Facility. (VMM)
3	3	*/
4	4

trunk/include/VBox/dbgfsel.h

r19463	r21217
1	1	/** @file
2		* DBGF - Debugger Facility, selector interface partly shared with SELM.
	2	* DBGF - Debugger Facility, selector interface partly shared with SELM. (VMM)
3	3	*/
4	4

trunk/include/VBox/dbggui.h

r20374	r21217
1	1	/** @file
2		* DBGGUI - The VirtualBox Debugger GUI.
	2	* DBGGUI - The VirtualBox Debugger GUI. (VBoxDbg)
3	3	*/
4	4

trunk/include/VBox/em.h

r20588	r21217
1	1	/** @file
2		* EM - Execution Monitor.
	2	* EM - Execution Monitor. (VMM)
3	3	*/
4	4

trunk/include/VBox/gmm.h

r20374	r21217
1	1	/** @file
2		* GMM - The Global Memory Manager.
	2	* GMM - The Global Memory Manager. (VMM)
3	3	*/
4	4

trunk/include/VBox/gvm.h

r19395	r21217
1	1	/* $Id$ */
2	2	/** @file
3		* GVM - The Global VM Data.
	3	* GVM - The Global VM Data. (VMM)
4	4	*/
5	5

trunk/include/VBox/gvmm.h

r20374	r21217
1	1	/* $Id$ */
2	2	/** @file
3		* GVMM - The Global VM Manager.
	3	* GVMM - The Global VM Manager. (VMM)
4	4	*/
5	5

trunk/include/VBox/hgcmsvc.h

-              r14389
+              r21217
 /** @file
+ * VBox - Host-Guest Communication Manager (HGCM):
+ * Service library definitions.
+ * Host-Guest Communication Manager (HGCM) - Service library definitions.
  */
 …
 /** Service specific extension callback.
  *  This callback is called by the service to perform service specific operation.
+ *
+ *
  * @param pvExtension The extension pointer.
  * @param u32Function What the callback is supposed to do.
 …
      */
     DECLR3CALLBACKMEMBER(int, pfnHostCall, (void *pvService, uint32_t function, uint32_t cParms, VBOXHGCMSVCPARM paParms[]));
     /** Inform the service about a VM save operation. */
     DECLR3CALLBACKMEMBER(int, pfnSaveState, (void *pvService, uint32_t u32ClientID, void *pvClient, PSSMHANDLE pSSM));

trunk/include/VBox/hwacc_svm.h

r19903	r21217
1	1	/** @file
2		* HWACCM - SVM Structures and Definitions.
	2	* HWACCM - SVM Structures and Definitions. (VMM)
3	3	*/
4	4

trunk/include/VBox/hwacc_vmx.h

r19984	r21217
1	1	/** @file
2		* HWACCM - VMX Structures and Definitions.
	2	* HWACCM - VMX Structures and Definitions. (VMM)
3	3	*/
4	4

trunk/include/VBox/hwaccm.h

r21210	r21217
1	1	/** @file
2		* HWACCM - Intel/AMD VM Hardware Support Manager
	2	* HWACCM - Intel/AMD VM Hardware Support Manager (VMM)
3	3	*/
4	4

trunk/include/VBox/intnet.h

r20374	r21217
1	1	/** @file
2		* INETNET - Internal Networking.
	2	* INETNET - Internal Networking. (DEV,++)
3	3	*/
4	4

trunk/include/VBox/iom.h

r20374	r21217
1	1	/** @file
2		* IOM - Input / Output Monitor.
	2	* IOM - Input / Output Monitor. (VMM)
3	3	*/
4	4

trunk/include/VBox/mm.h

r21094	r21217
1	1	/** @file
2		* MM - The Memory Manager.
	2	* MM - The Memory Manager. (VMM)
3	3	*/
4	4

trunk/include/VBox/param.h

r20742	r21217
1	1	/** @file
2		* VirtualBox Parameter Definitions.
	2	* VirtualBox Parameter Definitions. (VMM,+)
3	3	*
4	4	* param.mac is generated from this file by running 'kmk incs' in the root.

trunk/include/VBox/patm.h

r20374	r21217
1	1	/** @file
2		* PATM - Dynamic Guest OS Patching Manager
	2	* PATM - Dynamic Guest OS Patching Manager. (VMM)
3	3	*/
4	4

trunk/include/VBox/pci.h

r20154	r21217
1	1	/** @file
2		* PCI - The PCI Controller And Devices.
	2	* PCI - The PCI Controller And Devices. (DEV)
3	3	*/
4	4

trunk/include/VBox/pdm.h

r11292	r21217
1	1	/** @file
2		* PDM - Pluggable Device Manager.
	2	* PDM - Pluggable Device Manager. (VMM)
3	3	*/
4	4

trunk/include/VBox/pdmapi.h

r21188	r21217
1	1	/** @file
2		* PDM - Pluggable Device Manager, Core API.
	2	* PDM - Pluggable Device Manager, Core API. (VMM)
3	3	*
4	4	* The 'Core API' has been put in a different header because everyone

trunk/include/VBox/pdmasynccompletion.h

r20374	r21217
1	1	/* $Id$ */
2	2	/** @file
3		* PDM - Pluggable Device Manager, Async I/O Completion.
	3	* PDM - Pluggable Device Manager, Async I/O Completion. (VMM)
4	4	*/
5	5

trunk/include/VBox/pdmasynctask.h

r20374	r21217
1	1	/** @file
2		* PDM - Pluggable Device Manager, Async Task.
	2	* PDM - Pluggable Device Manager, Async Task. (VMM)
3	3	*/
4	4

trunk/include/VBox/pdmcritsect.h

r20874	r21217
1	1	/** @file
2		* PDM - Pluggable Device Manager, Critical Sections.
	2	* PDM - Pluggable Device Manager, Critical Sections. (VMM)
3	3	*/
4	4

trunk/include/VBox/pdmdev.h

r21188	r21217
1	1	/** @file
2		* PDM - Pluggable Device Manager, Devices.
	2	* PDM - Pluggable Device Manager, Devices. (VMM)
3	3	*/
4	4

trunk/include/VBox/pdmdrv.h

r20864	r21217
1	1	/** @file
2		* PDM - Pluggable Device Manager, Drivers.
	2	* PDM - Pluggable Device Manager, Drivers. (VMM)
3	3	*/
4	4

trunk/include/VBox/pdmifs.h

r20374	r21217
1	1	/** @file
2		* PDM - Pluggable Device Manager, Interfaces.
	2	* PDM - Pluggable Device Manager, Interfaces. (VMM)
3	3	*/
4	4

trunk/include/VBox/pdmins.h

r13832	r21217
1	1	/** @file
2		* PDM - Pluggable Device Manager, Common Instance Macros.
	2	* PDM - Pluggable Device Manager, Common Instance Macros. (VMM)
3	3	*/
4	4

trunk/include/VBox/pdmqueue.h

r20374	r21217
1	1	/** @file
2		* PDM - Pluggable Device Manager, Queues.
	2	* PDM - Pluggable Device Manager, Queues. (VMM)
3	3	*/
4	4

trunk/include/VBox/pdmsrv.h

-              r20374
+              r21217
 /** @file
+ * PDM - Pluggable Device Manager, VM Services.
+ * PDM - Pluggable Device Manager, VM Services. (VMM)
+ *
+ * @todo    This has not been implemented, consider dropping the concept.
  */

trunk/include/VBox/pdmthread.h

r20374	r21217
1	1	/** @file
2		* PDM - Pluggable Device Manager, Threads.
	2	* PDM - Pluggable Device Manager, Threads. (VMM)
3	3	*/
4	4

trunk/include/VBox/pdmusb.h

r20374	r21217
1	1	/** @file
2		* PDM - Pluggable Device Manager, USB Devices.
	2	* PDM - Pluggable Device Manager, USB Devices. (VMM)
3	3	*/
4	4

trunk/include/VBox/pgm.h

r20567	r21217
1	1	/** @file
2		* PGM - Page Monitor / Monitor.
	2	* PGM - Page Monitor / Monitor. (VMM)
3	3	*/
4	4

trunk/include/VBox/rem.h

r20871	r21217
1	1	/** @file
2		* REM - The Recompiled Execution Manager.
	2	* REM - The Recompiled Execution Manager. (VMM)
3	3	*/
4	4

trunk/include/VBox/scsi.h

r19968	r21217
1	1	/** @file
2		* VirtualBox - SCSI declarations.
	2	* VirtualBox - SCSI declarations. (DEV,+)
3	3	*/
4	4

trunk/include/VBox/selm.h

r20374	r21217
1	1	/** @file
2		* SELM - The Selector Manager.
	2	* SELM - The Selector Manager. (VMM)
3	3	*/
4	4

trunk/include/VBox/settings.h

r21085	r21217
1	1	/** @file
2		* Settings File Manipulation API.
	2	* Settings File Manipulation API. (Main)
3	3	*/
4	4

trunk/include/VBox/shflsvc.h

-              r21177
+              r21217
 /** @file
+ * Shared Folders:
+ * Common header for host service and guest clients.
+ * Shared Folders: Common header for host service and guest clients. (ADD,HSvc)
  */
 …
+/** Some bit flag manipulation macros. to be moved to VBox/cdefs.h? */
+/** @name Some bit flag manipulation macros.
+ * @{  */
 #ifndef BIT_FLAG
 #define BIT_FLAG(__Field,__Flag)       ((__Field) & (__Flag))
 …
 #define BIT_FLAG_CLEAR(__Field,__Flag) ((__Field) &= ~(__Flag))
 #endif
+/** @} */

trunk/include/VBox/ssm.h

r20374	r21217
1	1	/** @file
2		* SSM - The Save State Manager.
	2	* SSM - The Save State Manager. (VMM)
3	3	*/
4	4

trunk/include/VBox/stam.h

r20681	r21217
1	1	/** @file
2		* STAM - Statistics Manager.
	2	* STAM - Statistics Manager. (VMM)
3	3	*/
4	4

trunk/include/VBox/sup.h

r20866	r21217
1	1	/** @file
2		* SUP - Support Library.
	2	* SUP - Support Library. (HDrv)
3	3	*/
4	4

trunk/include/VBox/tm.h

r20733	r21217
1	1	/** @file
2		* TM - Time Manager.
	2	* TM - Time Manager. (VMM)
3	3	*/
4	4

trunk/include/VBox/trpm.h

r20374	r21217
1	1	/** @file
2		* TRPM - The Trap Monitor.
	2	* TRPM - The Trap Monitor. (VMM)
3	3	*/
4	4

trunk/include/VBox/usb.h

r20374	r21217
1	1	/** @file
2		* USB - Universal Serial Bus.
	2	* USB - Universal Serial Bus. (DEV,Main?)
3	3	*/
4	4

trunk/include/VBox/usblib-win.h

-              r20989
+              r21217
 /** @file
  * USBLIB - USB Support Library:
  * This module implements the basic low-level OS interfaces for Windows hosts.
+ * USBLib - Library for wrapping up the VBoxUSB functionality, Windows flavor.
+ * (DEV,HDrv,Main)
  */

trunk/include/VBox/usblib.h

r20374	r21217
1	1	/** @file
2		* USBLIB - USB Support Library.
3		* This module implements the basic low-level OS interfaces.
	2	* USBLib - Library for wrapping up the VBoxUSB functionality. (DEV,HDrv,Main)
4	3	*/
5	4

trunk/include/VBox/uvm.h

r19217	r21217
1	1	/* $Id$ */
2	2	/** @file
3		* GVM - The Global VM Data.
	3	* GVM - The Global VM Data. (VMM)
4	4	*/
5	5

trunk/include/VBox/version.h

-              r18178
+              r21217
 /** @file
  * Version management
+ * VBox Version Management.
  */
 …
 #ifndef RC_INVOKED
 #include <version-generated.h>
+# include <version-generated.h>
 /** Combined version number. */
 #define VBOX_VERSION                    (VBOX_VERSION_MAJOR << 16 | VBOX_VERSION_MINOR)
+# define VBOX_VERSION                    (VBOX_VERSION_MAJOR << 16 | VBOX_VERSION_MINOR)
 /** Get minor version from combined version */
 #define VBOX_GET_VERSION_MINOR(uVer)    (uVer & 0xffff)
+# define VBOX_GET_VERSION_MINOR(uVer)    (uVer & 0xffff)
 /** Get major version from combined version. */
 #define VBOX_GET_VERSION_MAJOR(uVer)    (uVer >> 16)
 #endif
+# define VBOX_GET_VERSION_MAJOR(uVer)    (uVer >> 16)
+#endif /* !RC_INVOKED */
 /** Vendor name */

trunk/include/VBox/vm.h

r21145	r21217
1	1	/** @file
2		* VM - The Virtual Machine, data.
	2	* VM - The Virtual Machine, data. (VMM)
3	3	*/
4	4

trunk/include/VBox/vmapi.h

r20374	r21217
1	1	/** @file
2		* VM - The Virtual Machine, API.
	2	* VM - The Virtual Machine, API. (VMM)
3	3	*/
4	4

trunk/include/VBox/vmm.h

r21000	r21217
1	1	/** @file
2		* VMM - The Virtual Machine Monitor.
	2	* VMM - The Virtual Machine Monitor. (VMM)
3	3	*/
4	4

trunk/include/VBox/vrdpapi.h

r20973	r21217
1	1	/** @file
2		* VBox Remote Desktop Protocol:
3		* Public APIs.
	2	* VBox Remote Desktop Protocol - Public APIs. (VRDP)
4	3	*/
5	4

trunk/include/VBox/vrdpusb.h

r13832	r21217
1	1	/** @file
2		* VBox Remote Desktop Protocol:
3		* Remote USB backend interface.
	2	* VBox Remote Desktop Protocol - Remote USB backend interface. (VRDP)
4	3	*/
5	4

trunk/include/VBox/vusb.h

r20374	r21217
1	1	/** @file
2		* VUSB - VirtualBox USB.
	2	* VUSB - VirtualBox USB. (DEV,VMM)
3	3	*/
4	4

trunk/include/VBox/x86.h

r20742	r21217
1	1	/** @file
2		* X86 (and AMD64) Structures and Definitions.
	2	* X86 (and AMD64) Structures and Definitions (VMM,++).
3	3	*
4	4	* x86.mac is generated from this file by running 'kmk incs' in the root.

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

Changeset 21217 in vbox for trunk/include

Legend:

Download in other formats: