summaryrefslogtreecommitdiff
path: root/gr-noaa
diff options
context:
space:
mode:
authorTom Rondeau <trondeau@vt.edu>2011-11-27 16:41:43 -0500
committerTom Rondeau <trondeau@vt.edu>2011-11-27 16:41:43 -0500
commit96132193e83a620a24722c978a46e515ee0ddf66 (patch)
treea184ad01a513936ed1757540a9b33ff8747630ee /gr-noaa
parent6c50cfa96ee15892c67e56585ded57b0fe405f59 (diff)
docs: added python doxygen docs to gr-noaa
Diffstat (limited to 'gr-noaa')
-rw-r--r--gr-noaa/swig/CMakeLists.txt3
-rw-r--r--gr-noaa/swig/__init__.py4
-rw-r--r--gr-noaa/swig/noaa_swig.i3
3 files changed, 10 insertions, 0 deletions
diff --git a/gr-noaa/swig/CMakeLists.txt b/gr-noaa/swig/CMakeLists.txt
index 1d754aabb4..054d0f942e 100644
--- a/gr-noaa/swig/CMakeLists.txt
+++ b/gr-noaa/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}/noaa_swig_doc.i)
+set(GR_SWIG_DOC_DIRS ${GR_NOAA_INCLUDE_DIRS})
+
set(GR_SWIG_LIBRARIES gnuradio-noaa)
GR_SWIG_MAKE(noaa_swig noaa_swig.i)
diff --git a/gr-noaa/swig/__init__.py b/gr-noaa/swig/__init__.py
index d8d337e65d..b82603953c 100644
--- a/gr-noaa/swig/__init__.py
+++ b/gr-noaa/swig/__init__.py
@@ -21,6 +21,10 @@
# The presence of this file turns this directory into a Python package
+'''
+The GNU Radio NOAA package.
+'''
+
# Add SWIG generated code to this namespace
from noaa_swig import *
diff --git a/gr-noaa/swig/noaa_swig.i b/gr-noaa/swig/noaa_swig.i
index 3b6e92149f..bc139651dc 100644
--- a/gr-noaa/swig/noaa_swig.i
+++ b/gr-noaa/swig/noaa_swig.i
@@ -22,6 +22,9 @@
%include "gnuradio.i"
+//load generated python docstrings
+%include "noaa_swig_doc.i"
+
%{
#include <noaa_hrpt_decoder.h>
#include <noaa_hrpt_deframer.h>