summaryrefslogtreecommitdiff
path: root/gr-shd
diff options
context:
space:
mode:
authorTom Rondeau2011-11-27 17:02:33 -0500
committerTom Rondeau2011-11-27 17:02:33 -0500
commitb1b20afb9e864ab9109dab2f081af38f7f2b7ae7 (patch)
treecfc0218de760e8a28cf03f6a9f54ccfa8d0c5027 /gr-shd
parent07bed9fa807f63fb155c6cbe1439e5871f4914dd (diff)
downloadgnuradio-b1b20afb9e864ab9109dab2f081af38f7f2b7ae7.tar.gz
gnuradio-b1b20afb9e864ab9109dab2f081af38f7f2b7ae7.tar.bz2
gnuradio-b1b20afb9e864ab9109dab2f081af38f7f2b7ae7.zip
docs: added python doxygen docs to gr-shd
Diffstat (limited to 'gr-shd')
-rw-r--r--gr-shd/swig/CMakeLists.txt4
-rw-r--r--gr-shd/swig/__init__.py4
-rw-r--r--gr-shd/swig/shd_swig.i3
3 files changed, 11 insertions, 0 deletions
diff --git a/gr-shd/swig/CMakeLists.txt b/gr-shd/swig/CMakeLists.txt
index e2c345be7..a8510cfa8 100644
--- a/gr-shd/swig/CMakeLists.txt
+++ b/gr-shd/swig/CMakeLists.txt
@@ -29,6 +29,10 @@ set(GR_SWIG_INCLUDE_DIRS
${GR_SHD_INCLUDE_DIRS}
${GNURADIO_CORE_SWIG_INCLUDE_DIRS}
)
+
+set(GR_SWIG_DOC_FILE ${CMAKE_CURRENT_BINARY_DIR}/shd_swig_doc.i)
+set(GR_SWIG_DOC_DIRS ${GR_SHD_INCLUDE_DIRS})
+
link_directories(${SHD_LIBRARY_DIRS})
set(GR_SWIG_LIBRARIES gnuradio-shd ${SHD_LIBRARIES})
diff --git a/gr-shd/swig/__init__.py b/gr-shd/swig/__init__.py
index 17589625c..d34eb214a 100644
--- a/gr-shd/swig/__init__.py
+++ b/gr-shd/swig/__init__.py
@@ -19,6 +19,10 @@
# Boston, MA 02110-1301, USA.
#
+'''
+GNU Radio package for the Symplex Hardware Driver.
+'''
+
########################################################################
# Prepare shd swig module to make it more pythonic
########################################################################
diff --git a/gr-shd/swig/shd_swig.i b/gr-shd/swig/shd_swig.i
index 217b2f1af..4ff200ec6 100644
--- a/gr-shd/swig/shd_swig.i
+++ b/gr-shd/swig/shd_swig.i
@@ -26,6 +26,9 @@
#define GR_SHD_API
+//load generated python docstrings
+%include "shd_swig_doc.i"
+
////////////////////////////////////////////////////////////////////////
// Language independent exception handler
////////////////////////////////////////////////////////////////////////