Audio: File header adjustments. bugref:9890

git-svn-id: https://www.virtualbox.org/svn/vbox/trunk@88235 cfe28804-0f27-0410-a406-dd0f0b0b656f

27 files changed, 36 insertions, 39 deletions

diff --git a/src/VBox/Devices/Audio/AudioHlp.cpp b/src/VBox/Devices/Audio/AudioHlp.cpp
index c50cb19fd7f..c087bbb0388 100644
--- a/src/VBox/Devices/Audio/AudioHlp.cpp
+++ b/src/VBox/Devices/Audio/AudioHlp.cpp
@@ -1,9 +1,8 @@
 /* $Id$ */
 /** @file
- * Intermedia audio driver, common routines.
+ * Audio helper routines.
  *
- * These are also used in the drivers which are bound to Main, e.g. the VRDE
- * or the video audio recording drivers.
+ * These are used with both drivers and devices.
  */
 
 /*
diff --git a/src/VBox/Devices/Audio/AudioHlp.h b/src/VBox/Devices/Audio/AudioHlp.h
index 9bd4aab8790..23544e70e70 100644
--- a/src/VBox/Devices/Audio/AudioHlp.h
+++ b/src/VBox/Devices/Audio/AudioHlp.h
@@ -1,6 +1,6 @@
 /* $Id$ */
 /** @file
- * Intermediate audio driver header.
+ * Audio helper routines.
  */
 
 /*
diff --git a/src/VBox/Devices/Audio/AudioMixer.cpp b/src/VBox/Devices/Audio/AudioMixer.cpp
index c4f0a03d9fd..570839c3472 100644
--- a/src/VBox/Devices/Audio/AudioMixer.cpp
+++ b/src/VBox/Devices/Audio/AudioMixer.cpp
@@ -2,7 +2,8 @@
 /** @file
  * Audio mixing routines for multiplexing audio sources in device emulations.
  *
- * == Overview
+ * Overview
+ * ========
  *
  * This mixer acts as a layer between the audio connector interface and
  * the actual device emulation, providing mechanisms for audio sources (input)
@@ -27,7 +28,8 @@
  * so-called mixer streams, which then in turn have pointers to the actual
  * PDM audio input/output streams.
  *
- * == Playback
+ * Playback
+ * ========
  *
  * For output sinks there can be one or more mixing stream attached.
  * As the host sets the overall pace for the device emulation (virtual time
@@ -45,7 +47,8 @@
  * conversion must be done, instead of each stream having to iterate over the
  * data.
  *
- * == Recording
+ * Recording
+ * =========
  *
  * For input sinks only one mixing stream at a time can be the recording
  * source currently. A recording source is optional, e.g. it is possible to
diff --git a/src/VBox/Devices/Audio/DevHda.cpp b/src/VBox/Devices/Audio/DevHda.cpp
index aae711f4dc3..2ef05bddcae 100644
--- a/src/VBox/Devices/Audio/DevHda.cpp
+++ b/src/VBox/Devices/Audio/DevHda.cpp
@@ -1,6 +1,6 @@
 /* $Id$ */
 /** @file
- * DevHDA.cpp - VBox Intel HD Audio Controller.
+ * Intel HD Audio Controller Emulation.
  *
  * Implemented against the specifications found in "High Definition Audio
  * Specification", Revision 1.0a June 17, 2010, and  "Intel I/O Controller
diff --git a/src/VBox/Devices/Audio/DevHda.h b/src/VBox/Devices/Audio/DevHda.h
index 9dae01eb07f..173aad4425a 100644
--- a/src/VBox/Devices/Audio/DevHda.h
+++ b/src/VBox/Devices/Audio/DevHda.h
@@ -1,6 +1,6 @@
 /* $Id$ */
 /** @file
- * DevHDA.h - VBox Intel HD Audio Controller.
+ * Intel HD Audio Controller Emulation - Structures.
  */
 
 /*
diff --git a/src/VBox/Devices/Audio/DevHdaCodec.cpp b/src/VBox/Devices/Audio/DevHdaCodec.cpp
index 256e0a3e147..21234ad1d50 100644
--- a/src/VBox/Devices/Audio/DevHdaCodec.cpp
+++ b/src/VBox/Devices/Audio/DevHdaCodec.cpp
@@ -1,6 +1,6 @@
 /* $Id$ */
 /** @file
- * HDACodec - VBox HD Audio Codec.
+ * Intel HD Audio Controller Emulation - Codec, Sigmatel/IDT STAC9220.
  *
  * Implemented based on the Intel HD Audio specification and the
  * Sigmatel/IDT STAC9220 datasheet.
diff --git a/src/VBox/Devices/Audio/DevHdaCodec.h b/src/VBox/Devices/Audio/DevHdaCodec.h
index 05f5bd53516..e75f102212e 100644
--- a/src/VBox/Devices/Audio/DevHdaCodec.h
+++ b/src/VBox/Devices/Audio/DevHdaCodec.h
@@ -1,6 +1,6 @@
 /* $Id$ */
 /** @file
- * HDACodec - VBox HD Audio Codec.
+ * Intel HD Audio Controller Emulation - Codec, Sigmatel/IDT STAC9220.
  */
 
 /*
diff --git a/src/VBox/Devices/Audio/DevHdaCommon.cpp b/src/VBox/Devices/Audio/DevHdaCommon.cpp
index bb00480bff3..39c36ccf90f 100644
--- a/src/VBox/Devices/Audio/DevHdaCommon.cpp
+++ b/src/VBox/Devices/Audio/DevHdaCommon.cpp
@@ -1,6 +1,6 @@
 /* $Id$ */
 /** @file
- * DevHDACommon.cpp - Shared HDA device functions.
+ * Intel HD Audio Controller Emulation - Common stuff.
  *
  * @todo r=bird: Shared with whom exactly?
  */
diff --git a/src/VBox/Devices/Audio/DevHdaCommon.h b/src/VBox/Devices/Audio/DevHdaCommon.h
index a4afd5faf17..b672d21531f 100644
--- a/src/VBox/Devices/Audio/DevHdaCommon.h
+++ b/src/VBox/Devices/Audio/DevHdaCommon.h
@@ -1,6 +1,9 @@
 /* $Id$ */
 /** @file
- * DevHDACommon.h - Shared HDA device defines / functions.
+ * Intel HD Audio Controller Emulation - Common stuff.
+ *
+ * @todo r=bird: Wtf is this?   Do we have some other HDA implementations
+ *               that I'm not aware of that shares this code?
  */
 
 /*
diff --git a/src/VBox/Devices/Audio/DevHdaStream.cpp b/src/VBox/Devices/Audio/DevHdaStream.cpp
index ed40adbd5d8..088e30ee5d2 100644
--- a/src/VBox/Devices/Audio/DevHdaStream.cpp
+++ b/src/VBox/Devices/Audio/DevHdaStream.cpp
@@ -1,6 +1,6 @@
 /* $Id$ */
 /** @file
- * HDAStream.cpp - Stream functions for HD Audio.
+ * Intel HD Audio Controller Emulation - Streams.
  */
 
 /*
diff --git a/src/VBox/Devices/Audio/DevHdaStream.h b/src/VBox/Devices/Audio/DevHdaStream.h
index cb5434e57f3..a2d7a54b92c 100644
--- a/src/VBox/Devices/Audio/DevHdaStream.h
+++ b/src/VBox/Devices/Audio/DevHdaStream.h
@@ -1,6 +1,6 @@
 /* $Id$ */
 /** @file
- * HDAStream.h - Streams for HD Audio.
+ * Intel HD Audio Controller Emulation - Streams.
  */
 
 /*
diff --git a/src/VBox/Devices/Audio/DevHdaStreamChannel.cpp b/src/VBox/Devices/Audio/DevHdaStreamChannel.cpp
index 3cf0c5d5192..c12d8409880 100644
--- a/src/VBox/Devices/Audio/DevHdaStreamChannel.cpp
+++ b/src/VBox/Devices/Audio/DevHdaStreamChannel.cpp
@@ -1,6 +1,6 @@
 /* $Id$ */
 /** @file
- * HDAStreamChannel.cpp - Stream channel functions for HD Audio.
+ * Intel HD Audio Controller Emulation - Stream channel.
  */
 
 /*
diff --git a/src/VBox/Devices/Audio/DevHdaStreamChannel.h b/src/VBox/Devices/Audio/DevHdaStreamChannel.h
index 75f7a87e238..30d428319aa 100644
--- a/src/VBox/Devices/Audio/DevHdaStreamChannel.h
+++ b/src/VBox/Devices/Audio/DevHdaStreamChannel.h
@@ -1,6 +1,6 @@
 /* $Id$ */
 /** @file
- * HDAStreamChannel.h - Stream channel functions for HD Audio.
+ * Intel HD Audio Controller Emulation - Stream channel.
  */
 
 /*
diff --git a/src/VBox/Devices/Audio/DevHdaStreamMap.cpp b/src/VBox/Devices/Audio/DevHdaStreamMap.cpp
index 240f0f14281..ae7cdf75d15 100644
--- a/src/VBox/Devices/Audio/DevHdaStreamMap.cpp
+++ b/src/VBox/Devices/Audio/DevHdaStreamMap.cpp
@@ -1,6 +1,6 @@
 /* $Id$ */
 /** @file
- * HDAStreamMap.cpp - Stream mapping functions for HD Audio.
+ * Intel HD Audio Controller Emulation - Stream mapping (e.g. 5.1 -> stereo).
  */
 
 /*
diff --git a/src/VBox/Devices/Audio/DevHdaStreamMap.h b/src/VBox/Devices/Audio/DevHdaStreamMap.h
index 406000f9b10..d3f0c8cd907 100644
--- a/src/VBox/Devices/Audio/DevHdaStreamMap.h
+++ b/src/VBox/Devices/Audio/DevHdaStreamMap.h
@@ -1,6 +1,6 @@
 /* $Id$ */
 /** @file
- * HDAStreamMap.h - Stream map functions for HD Audio.
+ * Intel HD Audio Controller Emulation - Stream mapping (e.g. 5.1 -> stereo).
  */
 
 /*
diff --git a/src/VBox/Devices/Audio/DrvAudio.cpp b/src/VBox/Devices/Audio/DrvAudio.cpp
index 0388337d28b..bfe5e7eede7 100644
--- a/src/VBox/Devices/Audio/DrvAudio.cpp
+++ b/src/VBox/Devices/Audio/DrvAudio.cpp
@@ -1,9 +1,6 @@
 /* $Id$ */
 /** @file
- * Intermediate audio driver header.
- *
- * @remarks Intermediate audio driver for connecting the audio device emulation
- *          with the host backend.
+ * Intermediate audio driver - Connects the audio device emulation with the host backend.
  */
 
 /*
diff --git a/src/VBox/Devices/Audio/DrvHostAudioAlsa.cpp b/src/VBox/Devices/Audio/DrvHostAudioAlsa.cpp
index 97395dbdfca..2554481efa9 100644
--- a/src/VBox/Devices/Audio/DrvHostAudioAlsa.cpp
+++ b/src/VBox/Devices/Audio/DrvHostAudioAlsa.cpp
@@ -1,6 +1,6 @@
 /* $Id$ */
 /** @file
- * ALSA audio driver.
+ * Host audio driver - Advanced Linux Sound Architecture (ALSA).
  */
 
 /*
diff --git a/src/VBox/Devices/Audio/DrvHostAudioCoreAudio.cpp b/src/VBox/Devices/Audio/DrvHostAudioCoreAudio.cpp
index 23609a14818..2285b9c3a38 100644
--- a/src/VBox/Devices/Audio/DrvHostAudioCoreAudio.cpp
+++ b/src/VBox/Devices/Audio/DrvHostAudioCoreAudio.cpp
@@ -1,6 +1,6 @@
 /* $Id$ */
 /** @file
- * VBox audio devices - Mac OS X CoreAudio audio driver.
+ * Host audio driver - Mac OS X CoreAudio.
  */
 
 /*
diff --git a/src/VBox/Devices/Audio/DrvHostAudioCoreAudioAuth.mm b/src/VBox/Devices/Audio/DrvHostAudioCoreAudioAuth.mm
index f782f7f1f38..4ef235e12c2 100644
--- a/src/VBox/Devices/Audio/DrvHostAudioCoreAudioAuth.mm
+++ b/src/VBox/Devices/Audio/DrvHostAudioCoreAudioAuth.mm
@@ -1,6 +1,6 @@
 /* $Id$ */
 /** @file
- * VBox audio devices - Mac OS X CoreAudio audio driver, authorization helpers for Mojave+.
+ * Host audio driver - Mac OS X CoreAudio, authorization helpers for Mojave+.
  */
 
 /*
diff --git a/src/VBox/Devices/Audio/DrvHostAudioDSound.cpp b/src/VBox/Devices/Audio/DrvHostAudioDSound.cpp
index 53ead23bf64..5f5bc5b22ad 100644
--- a/src/VBox/Devices/Audio/DrvHostAudioDSound.cpp
+++ b/src/VBox/Devices/Audio/DrvHostAudioDSound.cpp
@@ -1,6 +1,6 @@
 /* $Id$ */
 /** @file
- * Windows host backend driver using DirectSound.
+ * Host audio driver - DirectSound (Windows).
  */
 
 /*
diff --git a/src/VBox/Devices/Audio/DrvHostAudioDSoundMMNotifClient.cpp b/src/VBox/Devices/Audio/DrvHostAudioDSoundMMNotifClient.cpp
index 8af0aa105e1..3c389f4cc60 100644
--- a/src/VBox/Devices/Audio/DrvHostAudioDSoundMMNotifClient.cpp
+++ b/src/VBox/Devices/Audio/DrvHostAudioDSoundMMNotifClient.cpp
@@ -1,7 +1,6 @@
 /* $Id$ */
 /** @file
- * DrvHostAudioDSoundMMNotifClient.cpp - Implementation of the IMMNotificationClient interface
- *                                to detect audio endpoint changes.
+ * Host audio driver - DSound - Implementation of the IMMNotificationClient interface to detect audio endpoint changes.
  */
 
 /*
diff --git a/src/VBox/Devices/Audio/DrvHostAudioDSoundMMNotifClient.h b/src/VBox/Devices/Audio/DrvHostAudioDSoundMMNotifClient.h
index 57ff024e2ed..58d9573dd7e 100644
--- a/src/VBox/Devices/Audio/DrvHostAudioDSoundMMNotifClient.h
+++ b/src/VBox/Devices/Audio/DrvHostAudioDSoundMMNotifClient.h
@@ -1,7 +1,6 @@
 /* $Id$ */
 /** @file
- * DrvHostAudioDSoundMMNotifClient.h - Implementation of the IMMNotificationClient interface
- *                              to detect audio endpoint changes.
+ * Host audio driver - DSound - Implementation of the IMMNotificationClient interface to detect audio endpoint changes.
  */
 
 /*
diff --git a/src/VBox/Devices/Audio/DrvHostAudioDebug.cpp b/src/VBox/Devices/Audio/DrvHostAudioDebug.cpp
index 19b4ae62d52..ce94069bbf8 100644
--- a/src/VBox/Devices/Audio/DrvHostAudioDebug.cpp
+++ b/src/VBox/Devices/Audio/DrvHostAudioDebug.cpp
@@ -1,8 +1,6 @@
 /* $Id$ */
 /** @file
- * Debug audio driver.
- *
- * Host backend for dumping and injecting audio data from/to the device emulation.
+ * Host audio driver - Debug - For dumping and injecting audio data from/to the device emulation.
  */
 
 /*
diff --git a/src/VBox/Devices/Audio/DrvHostAudioNull.cpp b/src/VBox/Devices/Audio/DrvHostAudioNull.cpp
index 2904473a450..00c9cf5d11e 100644
--- a/src/VBox/Devices/Audio/DrvHostAudioNull.cpp
+++ b/src/VBox/Devices/Audio/DrvHostAudioNull.cpp
@@ -1,6 +1,6 @@
 /* $Id$ */
 /** @file
- * NULL audio driver.
+ * Host audio driver - NULL.
  *
  * This also acts as a fallback if no other backend is available.
  */
diff --git a/src/VBox/Devices/Audio/DrvHostAudioOss.cpp b/src/VBox/Devices/Audio/DrvHostAudioOss.cpp
index 8d9c5257f12..ff002cb9622 100644
--- a/src/VBox/Devices/Audio/DrvHostAudioOss.cpp
+++ b/src/VBox/Devices/Audio/DrvHostAudioOss.cpp
@@ -1,6 +1,6 @@
 /* $Id$ */
 /** @file
- * OSS (Open Sound System) host audio backend.
+ * Host audio driver - OSS (Open Sound System).
  */
 
 /*
diff --git a/src/VBox/Devices/Audio/DrvHostAudioPulseAudio.cpp b/src/VBox/Devices/Audio/DrvHostAudioPulseAudio.cpp
index 068a5716a51..2c569799b5e 100644
--- a/src/VBox/Devices/Audio/DrvHostAudioPulseAudio.cpp
+++ b/src/VBox/Devices/Audio/DrvHostAudioPulseAudio.cpp
@@ -1,6 +1,6 @@
 /* $Id$ */
 /** @file
- * VBox audio devices: Pulse Audio audio driver.
+ * Host audio driver - Pulse Audio.
  */
 
 /*
diff --git a/src/VBox/Devices/Audio/DrvHostAudioValidationKit.cpp b/src/VBox/Devices/Audio/DrvHostAudioValidationKit.cpp
index 5cac87f3475..c8f23d55249 100644
--- a/src/VBox/Devices/Audio/DrvHostAudioValidationKit.cpp
+++ b/src/VBox/Devices/Audio/DrvHostAudioValidationKit.cpp
@@ -1,7 +1,6 @@
 /* $Id$ */
 /** @file
- * ValidationKit audio driver - host backend for dumping and injecting audio data
- *                              from/to the device emulation.
+ * Host audio driver - ValidationKit - For dumping and injecting audio data from/to the device emulation.
  */
 
 /*