summaryrefslogtreecommitdiff
path: root/gr-comedi
diff options
context:
space:
mode:
authorTom Rondeau2011-11-27 16:41:29 -0500
committerTom Rondeau2011-11-27 16:41:29 -0500
commit6c50cfa96ee15892c67e56585ded57b0fe405f59 (patch)
tree9c6787a1e4e7542368998437b2a99154bf2c0ac8 /gr-comedi
parent6e08854108887d23c4cac4b6e164205544c56099 (diff)
downloadgnuradio-6c50cfa96ee15892c67e56585ded57b0fe405f59.tar.gz
gnuradio-6c50cfa96ee15892c67e56585ded57b0fe405f59.tar.bz2
gnuradio-6c50cfa96ee15892c67e56585ded57b0fe405f59.zip
docs: added python doxygen docs to gr-comedi
Diffstat (limited to 'gr-comedi')
-rw-r--r--gr-comedi/src/CMakeLists.txt3
-rw-r--r--gr-comedi/src/comedi.i3
-rw-r--r--gr-comedi/src/comedi_sink_s.h2
3 files changed, 7 insertions, 1 deletions
diff --git a/gr-comedi/src/CMakeLists.txt b/gr-comedi/src/CMakeLists.txt
index 2573940dc..bbf0c9bb2 100644
--- a/gr-comedi/src/CMakeLists.txt
+++ b/gr-comedi/src/CMakeLists.txt
@@ -72,6 +72,9 @@ set(GR_SWIG_INCLUDE_DIRS
${GNURADIO_CORE_SWIG_INCLUDE_DIRS}
)
+set(GR_SWIG_DOC_FILE ${CMAKE_CURRENT_BINARY_DIR}/comedi_swig_doc.i)
+set(GR_SWIG_DOC_DIRS ${GR_COMEDI_INCLUDE_DIRS})
+
set(GR_SWIG_LIBRARIES gnuradio-comedi)
GR_SWIG_MAKE(comedi comedi.i)
diff --git a/gr-comedi/src/comedi.i b/gr-comedi/src/comedi.i
index 36865afbe..a15b4d3b9 100644
--- a/gr-comedi/src/comedi.i
+++ b/gr-comedi/src/comedi.i
@@ -22,6 +22,9 @@
%include "gnuradio.i" // the common stuff
+//load generated python docstrings
+%include "comedi_swig_doc.i"
+
%{
#include "comedi_sink_s.h"
#include "comedi_source_s.h"
diff --git a/gr-comedi/src/comedi_sink_s.h b/gr-comedi/src/comedi_sink_s.h
index 22f0428d4..b36d41304 100644
--- a/gr-comedi/src/comedi_sink_s.h
+++ b/gr-comedi/src/comedi_sink_s.h
@@ -31,7 +31,7 @@ class comedi_sink_s;
typedef boost::shared_ptr<comedi_sink_s> comedi_sink_s_sptr;
/*!
- * \brief make an COMEDI sink.
+ * \brief make a COMEDI sink.
*
* \param sampling_freq sampling rate in Hz
* \param dev COMEDI device name, e.g., "/dev/comedi0"