Changeset 1337

Timestamp:

02/15/08 02:32:09 (7 months ago)

Author:

rossb

Message:

resolved ticket #4 deleted V19-devel-readme.txt and moved relevant information from it into doxygen comments. improved doxygen documentation. wrapped config flags in pa_trace.h with #ifndef to allow them to be overridden using compiler flags.

Location:

portaudio/branches/v19-devel/include

Files:

• pa_asio.h (modified) (1 diff)
• pa_jack.h (modified) (1 diff)
• pa_linux_alsa.h (modified) (1 diff)
• pa_mac_core.h (modified) (1 diff)
• pa_win_ds.h (modified) (1 diff)
• pa_win_waveformat.h (modified) (1 diff)
• pa_win_wmme.h (modified) (1 diff)
• portaudio.h (modified) (1 diff)

portaudio/branches/v19-devel/include/pa_asio.h

@@ -41 +41 @@
 
 /** @file
+ @ingroup public_header
  @brief ASIO-specific PortAudio API extension header file.
 */

portaudio/branches/v19-devel/include/pa_jack.h

@@ -41 +41 @@
 
 /** @file
- * JACK-specific PortAudio API extension header file.
+ *  @ingroup public_header
+ *  @brief JACK-specific PortAudio API extension header file.
  */
 #include "portaudio.h"

portaudio/branches/v19-devel/include/pa_linux_alsa.h

@@ -41 +41 @@
 
 /** @file
- * ALSA-specific PortAudio API extension header file.
+ *  @ingroup public_header
+ *  @brief ALSA-specific PortAudio API extension header file.
  */
 #include "portaudio.h"

portaudio/branches/v19-devel/include/pa_mac_core.h

@@ -37 +37 @@
  * requested that these non-binding requests be included along with the 
  * license above.
+ */
+
+/** @file
+ *  @ingroup public_header
+ *  @brief CoreAudio-specific PortAudio API extension header file.
  */
 

portaudio/branches/v19-devel/include/pa_win_ds.h

@@ -40 +40 @@
 
 /** @file
+ @ingroup public_header
  @brief DirectSound-specific PortAudio API extension header file.
 */

portaudio/branches/v19-devel/include/pa_win_waveformat.h

@@ -41 +41 @@
 
 /** @file
+ @ingroup public_header
  @brief Windows specific PortAudio API extension and utilities header file.
 */

portaudio/branches/v19-devel/include/pa_win_wmme.h

@@ -40 +40 @@
 
 /** @file
+ @ingroup public_header
  @brief WMME-specific PortAudio API extension header file.
 */

portaudio/branches/v19-devel/include/portaudio.h

@@ -41 +41 @@
 
 /** @file
- @brief The PortAudio API.
+ @ingroup public_header
+ @brief The portable PortAudio API.
 */