diff options
| author | Tom Rondeau <trondeau@vt.edu> | 2011-10-09 21:58:40 -0400 |
|---|---|---|
| committer | Tom Rondeau <trondeau@vt.edu> | 2011-10-09 21:58:40 -0400 |
| commit | 79b68aa7f9f67a3ce2f48582bc062e8c5cba2413 (patch) | |
| tree | f3b3745af48e52aeee445f6efec307865dc821dd /gr-audio/lib | |
| parent | 7ba45cf3452123a4c08a4aa535da76b793d2eaf2 (diff) | |
docs: adding doc directory, Doxygen page, and README for audio package.
Diffstat (limited to 'gr-audio/lib')
| -rw-r--r-- | gr-audio/lib/alsa/audio_alsa_sink.h | 1 | ||||
| -rw-r--r-- | gr-audio/lib/alsa/audio_alsa_source.h | 1 | ||||
| -rw-r--r-- | gr-audio/lib/jack/audio_jack_sink.h | 1 | ||||
| -rw-r--r-- | gr-audio/lib/jack/audio_jack_source.h | 1 | ||||
| -rw-r--r-- | gr-audio/lib/oss/audio_oss_sink.h | 1 | ||||
| -rw-r--r-- | gr-audio/lib/oss/audio_oss_source.h | 1 | ||||
| -rw-r--r-- | gr-audio/lib/osx/audio_osx_sink.h | 1 | ||||
| -rw-r--r-- | gr-audio/lib/osx/audio_osx_source.h | 1 | ||||
| -rw-r--r-- | gr-audio/lib/portaudio/audio_portaudio_sink.h | 3 | ||||
| -rw-r--r-- | gr-audio/lib/portaudio/audio_portaudio_source.h | 3 | ||||
| -rw-r--r-- | gr-audio/lib/windows/audio_windows_sink.h | 1 | ||||
| -rw-r--r-- | gr-audio/lib/windows/audio_windows_source.h | 1 |
12 files changed, 14 insertions, 2 deletions
diff --git a/gr-audio/lib/alsa/audio_alsa_sink.h b/gr-audio/lib/alsa/audio_alsa_sink.h index 23e406d6b4..b33b846448 100644 --- a/gr-audio/lib/alsa/audio_alsa_sink.h +++ b/gr-audio/lib/alsa/audio_alsa_sink.h @@ -34,6 +34,7 @@ /*! * \brief audio sink using ALSA + * \ingroup audio_blk * * The sink has N input streams of floats, where N depends * on the hardware characteristics of the selected device. diff --git a/gr-audio/lib/alsa/audio_alsa_source.h b/gr-audio/lib/alsa/audio_alsa_source.h index e38af38724..142ae711a9 100644 --- a/gr-audio/lib/alsa/audio_alsa_source.h +++ b/gr-audio/lib/alsa/audio_alsa_source.h @@ -37,6 +37,7 @@ typedef boost::shared_ptr<audio_alsa_source> audio_alsa_source_sptr; /*! * \brief audio source using ALSA + * \ingroup audio_blk * * The source has between 1 and N input streams of floats, where N is * depends on the hardware characteristics of the selected device. diff --git a/gr-audio/lib/jack/audio_jack_sink.h b/gr-audio/lib/jack/audio_jack_sink.h index a11863ee0b..5500b3641f 100644 --- a/gr-audio/lib/jack/audio_jack_sink.h +++ b/gr-audio/lib/jack/audio_jack_sink.h @@ -32,6 +32,7 @@ int jack_sink_process (jack_nframes_t nframes, void *arg); /*! * \brief audio sink using JACK + * \ingroup audio_blk * * The sink has one input stream of floats. * diff --git a/gr-audio/lib/jack/audio_jack_source.h b/gr-audio/lib/jack/audio_jack_source.h index 858f34528f..a155bf95b4 100644 --- a/gr-audio/lib/jack/audio_jack_source.h +++ b/gr-audio/lib/jack/audio_jack_source.h @@ -32,6 +32,7 @@ int jack_source_process (jack_nframes_t nframes, void *arg); /*! * \brief audio source using JACK + * \ingroup audio_blk * * The source has one input stream of floats. * diff --git a/gr-audio/lib/oss/audio_oss_sink.h b/gr-audio/lib/oss/audio_oss_sink.h index 0d7280c2fe..47b1407d3b 100644 --- a/gr-audio/lib/oss/audio_oss_sink.h +++ b/gr-audio/lib/oss/audio_oss_sink.h @@ -28,6 +28,7 @@ /*! * \brief audio sink using OSS + * \ingroup audio_blk * * input signature is one or two streams of floats. * Input samples must be in the range [-1,1]. diff --git a/gr-audio/lib/oss/audio_oss_source.h b/gr-audio/lib/oss/audio_oss_source.h index b20ef5c05e..df9f68e420 100644 --- a/gr-audio/lib/oss/audio_oss_source.h +++ b/gr-audio/lib/oss/audio_oss_source.h @@ -28,6 +28,7 @@ /*! * \brief audio source using OSS + * \ingroup audio_blk * * Output signature is one or two streams of floats. * Output samples will be in the range [-1,1]. diff --git a/gr-audio/lib/osx/audio_osx_sink.h b/gr-audio/lib/osx/audio_osx_sink.h index 13bd95d536..e7598097d7 100644 --- a/gr-audio/lib/osx/audio_osx_sink.h +++ b/gr-audio/lib/osx/audio_osx_sink.h @@ -31,6 +31,7 @@ /*! * \brief audio sink using OSX + * \ingroup audio_blk * * input signature is one or two streams of floats. * Input samples must be in the range [-1,1]. diff --git a/gr-audio/lib/osx/audio_osx_source.h b/gr-audio/lib/osx/audio_osx_source.h index a373ea94fc..435172a2c3 100644 --- a/gr-audio/lib/osx/audio_osx_source.h +++ b/gr-audio/lib/osx/audio_osx_source.h @@ -31,6 +31,7 @@ /*! * \brief audio source using OSX + * \ingroup audio_blk * * Input signature is one or two streams of floats. * Samples must be in the range [-1,1]. diff --git a/gr-audio/lib/portaudio/audio_portaudio_sink.h b/gr-audio/lib/portaudio/audio_portaudio_sink.h index 6426a32acc..04a881f7e4 100644 --- a/gr-audio/lib/portaudio/audio_portaudio_sink.h +++ b/gr-audio/lib/portaudio/audio_portaudio_sink.h @@ -34,7 +34,8 @@ PaStreamCallback portaudio_sink_callback; /*! - * \ Audio sink using PORTAUDIO + * \brief Audio sink using PORTAUDIO + * \ingroup audio_blk * * Input samples must be in the range [-1,1]. */ diff --git a/gr-audio/lib/portaudio/audio_portaudio_source.h b/gr-audio/lib/portaudio/audio_portaudio_source.h index 245b3410b3..b555bc759f 100644 --- a/gr-audio/lib/portaudio/audio_portaudio_source.h +++ b/gr-audio/lib/portaudio/audio_portaudio_source.h @@ -33,7 +33,8 @@ PaStreamCallback portaudio_source_callback; /*! - * \ Audio source using PORTAUDIO + * \brief Audio source using PORTAUDIO + * \ingroup audio_blk * * Input samples must be in the range [-1,1]. */ diff --git a/gr-audio/lib/windows/audio_windows_sink.h b/gr-audio/lib/windows/audio_windows_sink.h index 6819bd448b..d4ca259b3b 100644 --- a/gr-audio/lib/windows/audio_windows_sink.h +++ b/gr-audio/lib/windows/audio_windows_sink.h @@ -34,6 +34,7 @@ /*! * \brief audio sink using winmm mmsystem (win32 only) + * \ingroup audio_blk * * input signature is one or two streams of floats. * Input samples must be in the range [-1,1]. diff --git a/gr-audio/lib/windows/audio_windows_source.h b/gr-audio/lib/windows/audio_windows_source.h index 36311968d9..9cb7895760 100644 --- a/gr-audio/lib/windows/audio_windows_source.h +++ b/gr-audio/lib/windows/audio_windows_source.h @@ -28,6 +28,7 @@ /*! * \brief audio source using winmm mmsystem (win32 only) + * \ingroup audio_blk * * Output signature is one or two streams of floats. * Output samples will be in the range [-1,1]. |