diff options
| author | Tom Rondeau | 2011-11-27 15:50:13 -0500 |
|---|---|---|
| committer | Tom Rondeau | 2011-11-27 15:50:13 -0500 |
| commit | 633fd3b6cfc6c735a5adf2e91328fed4c67d7f51 (patch) | |
| tree | dccc236f81a7d5559839543414cf60e704c8d7fb /gr-audio/swig | |
| parent | 0a21e2584c226496af2aa3b361bed3d6bd91ba41 (diff) | |
| download | gnuradio-633fd3b6cfc6c735a5adf2e91328fed4c67d7f51.tar.gz gnuradio-633fd3b6cfc6c735a5adf2e91328fed4c67d7f51.tar.bz2 gnuradio-633fd3b6cfc6c735a5adf2e91328fed4c67d7f51.zip | |
docs: added python doxygen docs to gr-audio.
Diffstat (limited to 'gr-audio/swig')
| -rw-r--r-- | gr-audio/swig/CMakeLists.txt | 3 | ||||
| -rw-r--r-- | gr-audio/swig/__init__.py | 7 | ||||
| -rw-r--r-- | gr-audio/swig/audio_swig.i | 3 |
3 files changed, 13 insertions, 0 deletions
diff --git a/gr-audio/swig/CMakeLists.txt b/gr-audio/swig/CMakeLists.txt index 3e7b7f861..bcc02cdb0 100644 --- a/gr-audio/swig/CMakeLists.txt +++ b/gr-audio/swig/CMakeLists.txt @@ -28,6 +28,9 @@ set(GR_SWIG_INCLUDE_DIRS ${GNURADIO_CORE_SWIG_INCLUDE_DIRS} ) +set(GR_SWIG_DOC_FILE ${CMAKE_CURRENT_BINARY_DIR}/audio_swig_doc.i) +set(GR_SWIG_DOC_DIRS ${GR_AUDIO_INCLUDE_DIRS}) + set(GR_SWIG_LIBRARIES gnuradio-audio) GR_SWIG_MAKE(audio_swig audio_swig.i) diff --git a/gr-audio/swig/__init__.py b/gr-audio/swig/__init__.py index 23efda07e..c1b9a0493 100644 --- a/gr-audio/swig/__init__.py +++ b/gr-audio/swig/__init__.py @@ -19,4 +19,11 @@ # Boston, MA 02110-1301, USA. # +''' +This is the gr-audio package. This package is used to connect to audio +sources (mic-in) and sinks (speaker-out) ports on a computer. The +underlying hardware driver is system and OS dependent and this module +should automatically discover the correct one to use. +''' + from audio_swig import * diff --git a/gr-audio/swig/audio_swig.i b/gr-audio/swig/audio_swig.i index 1e3cca299..71db0ae09 100644 --- a/gr-audio/swig/audio_swig.i +++ b/gr-audio/swig/audio_swig.i @@ -27,6 +27,9 @@ //////////////////////////////////////////////////////////////////////// %include "gnuradio.i" +//load generated python docstrings +%include "audio_swig_doc.i" + //////////////////////////////////////////////////////////////////////// // block headers //////////////////////////////////////////////////////////////////////// |