summaryrefslogtreecommitdiff
path: root/gr-pager
diff options
context:
space:
mode:
authorTom Rondeau2011-11-27 16:41:51 -0500
committerTom Rondeau2011-11-27 16:41:51 -0500
commitc8f9f435ca3006c835ef93de8c437443ea0ec88a (patch)
treeeacf1d934a1af3e55f8729d41d9c6120127e1205 /gr-pager
parent96132193e83a620a24722c978a46e515ee0ddf66 (diff)
downloadgnuradio-c8f9f435ca3006c835ef93de8c437443ea0ec88a.tar.gz
gnuradio-c8f9f435ca3006c835ef93de8c437443ea0ec88a.tar.bz2
gnuradio-c8f9f435ca3006c835ef93de8c437443ea0ec88a.zip
docs: added python doxygen docs to gr-pager
Diffstat (limited to 'gr-pager')
-rw-r--r--gr-pager/python/__init__.py4
-rw-r--r--gr-pager/swig/CMakeLists.txt3
-rw-r--r--gr-pager/swig/pager_swig.i3
3 files changed, 10 insertions, 0 deletions
diff --git a/gr-pager/python/__init__.py b/gr-pager/python/__init__.py
index 664b79942..fffefd51d 100644
--- a/gr-pager/python/__init__.py
+++ b/gr-pager/python/__init__.py
@@ -21,6 +21,10 @@
# The presence of this file turns this directory into a Python package
+'''
+The GNU Radio pager application.
+'''
+
from pager_swig import *
from flex_demod import flex_demod
from pager_utils import *
diff --git a/gr-pager/swig/CMakeLists.txt b/gr-pager/swig/CMakeLists.txt
index bfb34c929..dce4be910 100644
--- a/gr-pager/swig/CMakeLists.txt
+++ b/gr-pager/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}/pager_swig_doc.i)
+set(GR_SWIG_DOC_DIRS ${GR_PAGER_INCLUDE_DIRS})
+
set(GR_SWIG_LIBRARIES gnuradio-pager)
GR_SWIG_MAKE(pager_swig pager_swig.i)
diff --git a/gr-pager/swig/pager_swig.i b/gr-pager/swig/pager_swig.i
index 2896fa368..2cf54c2a7 100644
--- a/gr-pager/swig/pager_swig.i
+++ b/gr-pager/swig/pager_swig.i
@@ -21,6 +21,9 @@
%include "gnuradio.i"
+//load generated python docstrings
+%include "pager_swig_doc.i"
+
%{
#include "pager_flex_frame.h"
#include "pager_slicer_fb.h"