From a20c127a9469aeac9ec60bf432c4128c49349f34 Mon Sep 17 00:00:00 2001
From: Ben Reynwar
Date: Wed, 3 Nov 2010 20:53:07 -0700
Subject: Generation of python docstrings from doxygen xml.

swig_doc.i is a swig interface file containing all the docstrings.
It is generated using swig_doc.py and included by gnuradio.i.

Minor changes to the swig make files have been made so that the generation
of swig_doc.i occurs.
---
 gr-msdd6000/src/Makefile.swig.gen | 166 +++++++++++++++++++++++++++-----------
 1 file changed, 121 insertions(+), 45 deletions(-)

(limited to 'gr-msdd6000/src')

diff --git a/gr-msdd6000/src/Makefile.swig.gen b/gr-msdd6000/src/Makefile.swig.gen
index ced3979f7..9a3bb939b 100644
--- a/gr-msdd6000/src/Makefile.swig.gen
+++ b/gr-msdd6000/src/Makefile.swig.gen
@@ -33,21 +33,14 @@
 ## this has to be done in the including Makefile.am -before-
 ## Makefile.swig is included.
 
-
 msdd_pythondir_category ?= gnuradio/msdd
 msdd_pylibdir_category ?= $(msdd_pythondir_category)
 msdd_pythondir = $(pythondir)/$(msdd_pythondir_category)
 msdd_pylibdir = $(pyexecdir)/$(msdd_pylibdir_category)
 
-msdd_rs_pythondir_category ?= gnuradio/msdd_rs
-msdd_rs_pylibdir_category ?= $(msdd_rs_pythondir_category)
-msdd_rs_pythondir = $(pythondir)/$(msdd_rs_pythondir_category)
-msdd_rs_pylibdir = $(pyexecdir)/$(msdd_rs_pylibdir_category)
-
 ## SWIG headers are always installed into the same directory.
 
 msdd_swigincludedir = $(swigincludedir)
-msdd_rs_swigincludedir = $(swigincludedir)
 
 ## This is a template file for a "generated" Makefile addition (in
 ## this case, "Makefile.swig.gen").  By including the top-level
@@ -70,7 +63,6 @@ msdd_rs_swigincludedir = $(swigincludedir)
 ## the SWIG-generated files will be removed from the distribution.
 
 STAMPS += $(DEPDIR)/msdd-generate-*
-STAMPS += $(DEPDIR)/msdd_rs-generate-*
 
 ## Other cleaned files: dependency files generated by SWIG or this Makefile
 
@@ -80,40 +72,27 @@ MOSTLYCLEANFILES += $(DEPDIR)/*.S*
 ## .h file is sometimes built, but not always ... so that one has to
 ## be added manually by the including Makefile.am .
 
-swig_built_sources += msdd.py msdd_rs.py msdd.cc msdd_rs.cc
+swig_built_sources += msdd.py msdd.cc
 
 ## Various SWIG variables.  These can be overloaded in the including
 ## Makefile.am by setting the variable value there, then including
 ## Makefile.swig .
 
 msdd_swiginclude_HEADERS =		\
-	msdd.i				\
-	msdd_rs.i			\
+	msdd.i			\
 	$(msdd_swiginclude_headers)
 
 msdd_pylib_LTLIBRARIES =		\
 	_msdd.la
 
-msdd_rs_pylib_LTLIBRARIES =		\
-        _msdd_rs.la
-
 _msdd_la_SOURCES = 			\
-	msdd.cc				\
+	msdd.cc			\
 	$(msdd_la_swig_sources)
 
-_msdd_rs_la_SOURCES =          		\
-    msdd_rs.cc         			\
-    $(msdd_la_swig_sources)
-
-
 _msdd_la_LIBADD =			\
 	$(STD_SWIG_LA_LIB_ADD)		\
 	$(msdd_la_swig_libadd)
 
-_msdd_rs_la_LIBADD =           		\
-    $(STD_SWIG_LA_LIB_ADD)      	\
-    $(msdd_rs_la_swig_libadd)
-
 _msdd_la_LDFLAGS =			\
 	$(STD_SWIG_LA_LD_FLAGS)		\
 	$(msdd_la_swig_ldflags)
@@ -122,29 +101,18 @@ _msdd_la_CXXFLAGS =			\
 	$(STD_SWIG_CXX_FLAGS)		\
 	$(msdd_la_swig_cxxflags)
 
-_msdd_rs_la_LDFLAGS =          		\
-    $(STD_SWIG_LA_LD_FLAGS)     	\
-    $(msdd_rs_la_swig_ldflags)
-
-_msdd_rs_la_CXXFLAGS =         		\
-    $(STD_SWIG_CXX_FLAGS)       	\
-    $(msdd_rs_la_swig_cxxflags)
-
 msdd_python_PYTHON =			\
-	msdd.py				\
+	msdd.py			\
 	$(msdd_python)
 
-msdd_rs_python_PYTHON =		        \
-    msdd_rs.py         			\
-    $(msdd_rs_python)
-
 ## Entry rule for running SWIG
 
-msdd.h msdd.py msdd.cc: msdd.i
+msdd.h msdd.py msdd.cc: msdd.i $(top_srcdir)/gnuradio-core/src/lib/swig/swig_doc.i
 ## This rule will get called only when MAKE decides that one of the
 ## targets needs to be created or re-created, because:
 ##
-## * The .i file is newer than any or all of the generated files;
+## * The .i file or the swig_doc.i are newer than any or all of the
+##   generated files;
 ##
 ## * Any or all of the .cc, .h, or .py files does not exist and is
 ##   needed (in the case this file is not needed, the rule for it is
@@ -284,16 +252,127 @@ $(DEPDIR)/msdd-generate-stamp:
 ##
 	touch $(DEPDIR)/msdd-generate-stamp
 
+# KLUDGE: Force runtime include of a SWIG dependency file.  This is
+# not guaranteed to be portable, but will probably work.  If it works,
+# we have accurate dependencies for our swig stuff, which is good.
+
+@am__include@ @am__quote@./$(DEPDIR)/msdd.d@am__quote@
+
+# -*- Makefile -*-
+#
+# Copyright 2009 Free Software Foundation, Inc.
+# 
+# This file is part of GNU Radio
+# 
+# GNU Radio is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3, or (at your option)
+# any later version.
+# 
+# GNU Radio is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with GNU Radio; see the file COPYING.  If not, write to
+# the Free Software Foundation, Inc., 51 Franklin Street,
+# Boston, MA 02110-1301, USA.
+# 
+
+# Makefile.swig.gen for msdd_rs.i
+
+## Default install locations for these files:
+##
+## Default location for the Python directory is:
+##  ${prefix}/lib/python${python_version}/site-packages/[category]/msdd_rs
+## Default location for the Python exec directory is:
+##  ${exec_prefix}/lib/python${python_version}/site-packages/[category]/msdd_rs
+##
+## The following can be overloaded to change the install location, but
+## this has to be done in the including Makefile.am -before-
+## Makefile.swig is included.
+
+msdd_rs_pythondir_category ?= gnuradio/msdd_rs
+msdd_rs_pylibdir_category ?= $(msdd_rs_pythondir_category)
+msdd_rs_pythondir = $(pythondir)/$(msdd_rs_pythondir_category)
+msdd_rs_pylibdir = $(pyexecdir)/$(msdd_rs_pylibdir_category)
+
+## SWIG headers are always installed into the same directory.
+
+msdd_rs_swigincludedir = $(swigincludedir)
+
+## This is a template file for a "generated" Makefile addition (in
+## this case, "Makefile.swig.gen").  By including the top-level
+## Makefile.swig, this file will be used to generate the SWIG
+## dependencies.  Assign the variable TOP_SWIG_FILES to be the list of
+## SWIG .i files to generated wrappings for; there can be more than 1
+## so long as the names are unique (no sorting is done on the
+## TOP_SWIG_FILES list). This file explicitly assumes that a SWIG .i
+## file will generate .cc, .py, and possibly .h files -- meaning that
+## all of these files will have the same base name (that provided for
+## the SWIG .i file).
+##
+## This code is setup to ensure parallel MAKE ("-j" or "-jN") does the
+## right thing.  For more info, see <
+## http://sources.redhat.com/automake/automake.html#Multiple-Outputs >
+
+## Stamps used to ensure parallel make does the right thing.  These
+## are removed by "make clean", but otherwise unused except during the
+## parallel built.  These will not be included in a tarball, because
+## the SWIG-generated files will be removed from the distribution.
+
+STAMPS += $(DEPDIR)/msdd_rs-generate-*
+
+## Other cleaned files: dependency files generated by SWIG or this Makefile
+
+MOSTLYCLEANFILES += $(DEPDIR)/*.S*
+
+## Add the .py and .cc files to the list of SWIG built sources.  The
+## .h file is sometimes built, but not always ... so that one has to
+## be added manually by the including Makefile.am .
+
+swig_built_sources += msdd_rs.py msdd_rs.cc
+
+## Various SWIG variables.  These can be overloaded in the including
+## Makefile.am by setting the variable value there, then including
+## Makefile.swig .
 
+msdd_rs_swiginclude_HEADERS =		\
+	msdd_rs.i			\
+	$(msdd_rs_swiginclude_headers)
+
+msdd_rs_pylib_LTLIBRARIES =		\
+	_msdd_rs.la
+
+_msdd_rs_la_SOURCES = 			\
+	msdd_rs.cc			\
+	$(msdd_rs_la_swig_sources)
+
+_msdd_rs_la_LIBADD =			\
+	$(STD_SWIG_LA_LIB_ADD)		\
+	$(msdd_rs_la_swig_libadd)
+
+_msdd_rs_la_LDFLAGS =			\
+	$(STD_SWIG_LA_LD_FLAGS)		\
+	$(msdd_rs_la_swig_ldflags)
 
+_msdd_rs_la_CXXFLAGS =			\
+	$(STD_SWIG_CXX_FLAGS)		\
+	$(msdd_rs_la_swig_cxxflags)
 
+msdd_rs_python_PYTHON =			\
+	msdd_rs.py			\
+	$(msdd_rs_python)
 
+## Entry rule for running SWIG
 
-msdd_rs.h msdd_rs.py msdd_rs.cc: msdd_rs.i
+msdd_rs.h msdd_rs.py msdd_rs.cc: msdd_rs.i $(top_srcdir)/gnuradio-core/src/lib/swig/swig_doc.i
 ## This rule will get called only when MAKE decides that one of the
 ## targets needs to be created or re-created, because:
 ##
-## * The .i file is newer than any or all of the generated files;
+## * The .i file or the swig_doc.i are newer than any or all of the
+##   generated files;
 ##
 ## * Any or all of the .cc, .h, or .py files does not exist and is
 ##   needed (in the case this file is not needed, the rule for it is
@@ -316,7 +395,7 @@ msdd_rs.h msdd_rs.py msdd_rs.cc: msdd_rs.i
 ##
 ## Once execution gets to here, it should always proceed no matter the
 ## state of a stamp (as discussed in link above).  The
-## $(DEPDIR)/msdd-generate stuff is used to allow for parallel
+## $(DEPDIR)/msdd_rs-generate stuff is used to allow for parallel
 ## builds to "do the right thing".  The stamp has no relationship with
 ## either the target files or dependency file; it is used solely for
 ## the protection of multiple builds during a given call to MAKE.
@@ -437,8 +516,5 @@ $(DEPDIR)/msdd_rs-generate-stamp:
 # not guaranteed to be portable, but will probably work.  If it works,
 # we have accurate dependencies for our swig stuff, which is good.
 
-
-@am__include@ @am__quote@./$(DEPDIR)/msdd.d@am__quote@
 @am__include@ @am__quote@./$(DEPDIR)/msdd_rs.d@am__quote@
 
-
-- 
cgit 


From 44ad2b33d0b86f0ffe95d025fefa2c774cf80c85 Mon Sep 17 00:00:00 2001
From: Ben Reynwar
Date: Sun, 30 Jan 2011 13:36:24 -0700
Subject: Fixed Makefiles to generate swig_doc.i

---
 gr-msdd6000/src/Makefile.swig.gen | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'gr-msdd6000/src')

diff --git a/gr-msdd6000/src/Makefile.swig.gen b/gr-msdd6000/src/Makefile.swig.gen
index dbf137334..4f932f43c 100644
--- a/gr-msdd6000/src/Makefile.swig.gen
+++ b/gr-msdd6000/src/Makefile.swig.gen
@@ -105,7 +105,7 @@ _msdd_la_CXXFLAGS =			\
 	$(msdd_la_swig_cxxflags)
 
 python/msdd.cc: msdd.py
-msdd.py: msdd.i
+msdd.py: msdd.i $(top_srcdir)/gnuradio-core/src/lib/swig/swig_doc.i
 
 # Include the python dependencies for this file
 -include python/msdd.d
@@ -250,7 +250,7 @@ _msdd_rs_la_CXXFLAGS =			\
 	$(msdd_rs_la_swig_cxxflags)
 
 python/msdd_rs.cc: msdd_rs.py
-msdd_rs.py: msdd_rs.i
+msdd_rs.py: msdd_rs.i $(top_srcdir)/gnuradio-core/src/lib/swig/swig_doc.i
 
 # Include the python dependencies for this file
 -include python/msdd_rs.d
-- 
cgit 


From 315f45c234e2fa84fc83641c8404cc5fcdb8412e Mon Sep 17 00:00:00 2001
From: Ben Reynwar
Date: Sun, 27 Feb 2011 13:40:48 -0700
Subject: Removing docstring generation from this branch.

---
 gr-msdd6000/src/Makefile.swig.gen | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'gr-msdd6000/src')

diff --git a/gr-msdd6000/src/Makefile.swig.gen b/gr-msdd6000/src/Makefile.swig.gen
index 4f932f43c..255e11b29 100644
--- a/gr-msdd6000/src/Makefile.swig.gen
+++ b/gr-msdd6000/src/Makefile.swig.gen
@@ -105,7 +105,7 @@ _msdd_la_CXXFLAGS =			\
 	$(msdd_la_swig_cxxflags)
 
 python/msdd.cc: msdd.py
-msdd.py: msdd.i $(top_srcdir)/gnuradio-core/src/lib/swig/swig_doc.i
+msdd.py: msdd.i 
 
 # Include the python dependencies for this file
 -include python/msdd.d
@@ -250,7 +250,7 @@ _msdd_rs_la_CXXFLAGS =			\
 	$(msdd_rs_la_swig_cxxflags)
 
 python/msdd_rs.cc: msdd_rs.py
-msdd_rs.py: msdd_rs.i $(top_srcdir)/gnuradio-core/src/lib/swig/swig_doc.i
+msdd_rs.py: msdd_rs.i 
 
 # Include the python dependencies for this file
 -include python/msdd_rs.d
-- 
cgit