From 11d58fe2e58c83fffae0153b3d541e9928f04411 Mon Sep 17 00:00:00 2001 From: Josh Blum Date: Wed, 16 Nov 2011 23:40:13 -0800 Subject: work on swig docs, added to core and digital --- gnuradio-core/src/lib/swig/CMakeLists.txt | 40 +++++++++------------- gnuradio-core/src/lib/swig/gnuradio_core_filter.i | 2 ++ gnuradio-core/src/lib/swig/gnuradio_core_general.i | 2 ++ gnuradio-core/src/lib/swig/gnuradio_core_gengen.i | 2 ++ gnuradio-core/src/lib/swig/gnuradio_core_hier.i | 2 ++ gnuradio-core/src/lib/swig/gnuradio_core_io.i | 2 ++ gnuradio-core/src/lib/swig/gnuradio_core_runtime.i | 2 ++ 7 files changed, 29 insertions(+), 23 deletions(-) (limited to 'gnuradio-core/src') diff --git a/gnuradio-core/src/lib/swig/CMakeLists.txt b/gnuradio-core/src/lib/swig/CMakeLists.txt index aa289a18a..bb7ce9a81 100644 --- a/gnuradio-core/src/lib/swig/CMakeLists.txt +++ b/gnuradio-core/src/lib/swig/CMakeLists.txt @@ -45,23 +45,23 @@ set(GR_SWIG_LIBRARIES gnuradio-core) set(GR_SWIG_TARGET_DEPS gengen_generated filter_generated) -GR_SWIG_MAKE(gnuradio_core_runtime gnuradio_core_runtime.i) -GR_SWIG_MAKE(gnuradio_core_general gnuradio_core_general.i) -GR_SWIG_MAKE(gnuradio_core_gengen gnuradio_core_gengen.i) -GR_SWIG_MAKE(gnuradio_core_filter gnuradio_core_filter.i) -GR_SWIG_MAKE(gnuradio_core_io gnuradio_core_io.i) -GR_SWIG_MAKE(gnuradio_core_hier gnuradio_core_hier.i) - -GR_SWIG_INSTALL(TARGETS - gnuradio_core_runtime - gnuradio_core_general - gnuradio_core_gengen - gnuradio_core_filter - gnuradio_core_io - gnuradio_core_hier - DESTINATION ${GR_PYTHON_DIR}/gnuradio/gr - COMPONENT "core_python" -) +foreach(what runtime general gengen filter io hier) + SET(GR_SWIG_DOC_FILE ${CMAKE_CURRENT_BINARY_DIR}/${what}_swig_doc.i) + SET(GR_SWIG_DOC_DIRS ${CMAKE_CURRENT_SOURCE_DIR}/../${what} ${CMAKE_CURRENT_BINARY_DIR}/../${what}) + GR_SWIG_MAKE(gnuradio_core_${what} gnuradio_core_${what}.i) + GR_SWIG_INSTALL( + TARGETS gnuradio_core_${what} + DESTINATION ${GR_PYTHON_DIR}/gnuradio/gr + COMPONENT "core_python" + ) + install( + FILES + gnuradio_core_${what}.i + ${CMAKE_CURRENT_BINARY_DIR}/${what}_swig_doc.i + DESTINATION ${GR_INCLUDE_DIR}/gnuradio/swig + COMPONENT "core_swig" + ) +endforeach(what) ######################################################################## # Install various files @@ -70,12 +70,6 @@ install(FILES gnuradio.i gr_swig_block_magic.i gr_shared_ptr.i - gnuradio_core_runtime.i - gnuradio_core_general.i - gnuradio_core_gengen.i - gnuradio_core_filter.i - gnuradio_core_io.i - gnuradio_core_hier.i DESTINATION ${GR_INCLUDE_DIR}/gnuradio/swig COMPONENT "core_swig" ) diff --git a/gnuradio-core/src/lib/swig/gnuradio_core_filter.i b/gnuradio-core/src/lib/swig/gnuradio_core_filter.i index e825467db..952bf93b4 100644 --- a/gnuradio-core/src/lib/swig/gnuradio_core_filter.i +++ b/gnuradio-core/src/lib/swig/gnuradio_core_filter.i @@ -19,6 +19,8 @@ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. */ +%include "filter_swig_doc.i" + #ifndef SWIGIMPORTED %module(directors="1") gnuradio_core_filter #endif diff --git a/gnuradio-core/src/lib/swig/gnuradio_core_general.i b/gnuradio-core/src/lib/swig/gnuradio_core_general.i index b34d4f936..e39a0197a 100644 --- a/gnuradio-core/src/lib/swig/gnuradio_core_general.i +++ b/gnuradio-core/src/lib/swig/gnuradio_core_general.i @@ -19,6 +19,8 @@ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. */ +%include "general_swig_doc.i" + #define GR_CORE_API #ifndef SWIGIMPORTED diff --git a/gnuradio-core/src/lib/swig/gnuradio_core_gengen.i b/gnuradio-core/src/lib/swig/gnuradio_core_gengen.i index 496ced077..8753cd36b 100644 --- a/gnuradio-core/src/lib/swig/gnuradio_core_gengen.i +++ b/gnuradio-core/src/lib/swig/gnuradio_core_gengen.i @@ -19,6 +19,8 @@ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. */ +%include "gengen_swig_doc.i" + #ifndef SWIGIMPORTED %module(directors="1") gnuradio_core_gengen #endif diff --git a/gnuradio-core/src/lib/swig/gnuradio_core_hier.i b/gnuradio-core/src/lib/swig/gnuradio_core_hier.i index 0b8161c5d..bb9c71f53 100644 --- a/gnuradio-core/src/lib/swig/gnuradio_core_hier.i +++ b/gnuradio-core/src/lib/swig/gnuradio_core_hier.i @@ -19,6 +19,8 @@ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. */ +%include "hier_swig_doc.i" + #ifndef SWIGIMPORTED %module(directors="1") gnuradio_hier_hier #endif diff --git a/gnuradio-core/src/lib/swig/gnuradio_core_io.i b/gnuradio-core/src/lib/swig/gnuradio_core_io.i index 0d989ea87..d2fa0aede 100644 --- a/gnuradio-core/src/lib/swig/gnuradio_core_io.i +++ b/gnuradio-core/src/lib/swig/gnuradio_core_io.i @@ -19,6 +19,8 @@ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. */ +%include "io_swig_doc.i" + #ifndef SWIGIMPORTED %module(directors="1") gnuradio_core_io #endif diff --git a/gnuradio-core/src/lib/swig/gnuradio_core_runtime.i b/gnuradio-core/src/lib/swig/gnuradio_core_runtime.i index 579c51ce5..7fcac5069 100644 --- a/gnuradio-core/src/lib/swig/gnuradio_core_runtime.i +++ b/gnuradio-core/src/lib/swig/gnuradio_core_runtime.i @@ -20,6 +20,8 @@ * Boston, MA 02110-1301, USA. */ +%include "runtime_swig_doc.i" + #ifndef SWIGIMPORTED %module(directors="1") gnuradio_core_runtime #endif -- cgit From 0a21e2584c226496af2aa3b361bed3d6bd91ba41 Mon Sep 17 00:00:00 2001 From: Tom Rondeau Date: Sun, 27 Nov 2011 14:56:19 -0500 Subject: docs: autotools Makefile.am generates empty swig_docs .i files; builds in autotools and cmake. The autotools build does not auto-generate the Python documentation for each block like we do with the cmake build, but the empty .i files are required to build things regardless. The swig_doc.py and doxyxml files are distributed with the autotools build in case someone wants to generate this on their own (see README.doxyxml for how to do this). Only for gnuradio-core and gr-digital currently. --- gnuradio-core/src/lib/swig/Makefile.am | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'gnuradio-core/src') diff --git a/gnuradio-core/src/lib/swig/Makefile.am b/gnuradio-core/src/lib/swig/Makefile.am index d304a2123..162285017 100644 --- a/gnuradio-core/src/lib/swig/Makefile.am +++ b/gnuradio-core/src/lib/swig/Makefile.am @@ -40,6 +40,20 @@ TOP_SWIG_IFILES = \ gnuradio_core_io.i \ gnuradio_core_hier.i +TOP_SWIG_DOC_IFILES = \ + filter_swig_doc.i \ + general_swig_doc.i \ + gengen_swig_doc.i \ + hier_swig_doc.i \ + io_swig_doc.i \ + runtime_swig_doc.i + + +BUILT_SOURCES = \ + $(TOP_SWIG_DOC_IFILES) + +$(BUILT_SOURCES): + `echo "" > $@` # SWIG headers get installed in ${prefix}/include/gnuradio/swig swiginclude_HEADERS = \ -- cgit From 0408e48c26bfae60d4973e1f1128ac419d6268a2 Mon Sep 17 00:00:00 2001 From: Tom Rondeau Date: Mon, 28 Nov 2011 01:11:27 -0500 Subject: docs: installing generated _doc.i files under autotools. --- gnuradio-core/src/lib/swig/Makefile.am | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) (limited to 'gnuradio-core/src') diff --git a/gnuradio-core/src/lib/swig/Makefile.am b/gnuradio-core/src/lib/swig/Makefile.am index 162285017..0a3234dd6 100644 --- a/gnuradio-core/src/lib/swig/Makefile.am +++ b/gnuradio-core/src/lib/swig/Makefile.am @@ -49,12 +49,15 @@ TOP_SWIG_DOC_IFILES = \ runtime_swig_doc.i -BUILT_SOURCES = \ +BUILT_SOURCES += \ $(TOP_SWIG_DOC_IFILES) -$(BUILT_SOURCES): +$(TOP_SWIG_DOC_IFILES): `echo "" > $@` +install-data-local: + cp -p $(TOP_SWIG_DOC_IFILES) $(swigincludedir) + # SWIG headers get installed in ${prefix}/include/gnuradio/swig swiginclude_HEADERS = \ gnuradio.i \ -- cgit From fe2e6f8054ed8c6a19fe893553a0d05ce855179e Mon Sep 17 00:00:00 2001 From: Tom Rondeau Date: Sun, 4 Dec 2011 11:10:13 -0500 Subject: docs: better install of swig docs .i files since we actually have a variable to take care of it already. --- gnuradio-core/src/lib/swig/Makefile.am | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) (limited to 'gnuradio-core/src') diff --git a/gnuradio-core/src/lib/swig/Makefile.am b/gnuradio-core/src/lib/swig/Makefile.am index 0a3234dd6..9509dba32 100644 --- a/gnuradio-core/src/lib/swig/Makefile.am +++ b/gnuradio-core/src/lib/swig/Makefile.am @@ -52,17 +52,18 @@ TOP_SWIG_DOC_IFILES = \ BUILT_SOURCES += \ $(TOP_SWIG_DOC_IFILES) +EXTRA_DIST += \ + $(TOP_SWIG_DOC_IFILES) + $(TOP_SWIG_DOC_IFILES): `echo "" > $@` -install-data-local: - cp -p $(TOP_SWIG_DOC_IFILES) $(swigincludedir) - # SWIG headers get installed in ${prefix}/include/gnuradio/swig swiginclude_HEADERS = \ gnuradio.i \ gr_swig_block_magic.i \ - gr_shared_ptr.i + gr_shared_ptr.i \ + $(TOP_SWIG_DOC_IFILES) # SWIG headers that get installed in ${prefix}/include/gnuradio/swig/... nobase_swiginclude_HEADERS = \ -- cgit