From b3020389cf499b09724c4b6bfe5929980b6f24eb Mon Sep 17 00:00:00 2001
From: Ben Reynwar <ben@reynwar.net>
Date: Sun, 7 Apr 2013 21:00:28 -0700
Subject: docstrings: Include class documentation into SWIGed make function's
docstrings.
---
docs/doxygen/swig_doc.py | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
(limited to 'docs/doxygen')
diff --git a/docs/doxygen/swig_doc.py b/docs/doxygen/swig_doc.py
index f24608b3ee..2326f0e5bd 100644
--- a/docs/doxygen/swig_doc.py
+++ b/docs/doxygen/swig_doc.py
@@ -218,8 +218,10 @@ def make_block2_entry(di, block):
descriptions = []
# For new style blocks all the relevant documentation should be
# associated with the 'make' method.
+ class_description = combine_descriptions(block)
make_func = block.get_member('make', DoxyFunction)
- description = combine_descriptions(make_func)
+ make_description = combine_descriptions(make_func)
+ description = class_description + "\n\n" + make_description
# Associate the combined description with the class and
# the make function.
output = []
--
cgit v1.2.3
From 36dfc43ce9435faf61adae8dc955b8b3b411abdb Mon Sep 17 00:00:00 2001
From: Ben Reynwar <ben@reynwar.net>
Date: Sun, 7 Apr 2013 23:07:11 -0700
Subject: sphinx-docs: Minor updates to sphinx documentation.
---
docs/doxygen/swig_doc.py | 8 ++++----
docs/sphinx/gnuradio_sphinx.py | 16 +++++++++++++++-
docs/sphinx/source/gr/index.rst | 1 -
docs/sphinx/source/gr/misc.rst | 1 -
4 files changed, 19 insertions(+), 7 deletions(-)
(limited to 'docs/doxygen')
diff --git a/docs/doxygen/swig_doc.py b/docs/doxygen/swig_doc.py
index 2326f0e5bd..da104a2e00 100644
--- a/docs/doxygen/swig_doc.py
+++ b/docs/doxygen/swig_doc.py
@@ -221,13 +221,13 @@ def make_block2_entry(di, block):
class_description = combine_descriptions(block)
make_func = block.get_member('make', DoxyFunction)
make_description = combine_descriptions(make_func)
- description = class_description + "\n\n" + make_description
+ description = class_description + "\n\nConstructor Specific Documentation:\n\n" + make_description
# Associate the combined description with the class and
# the make function.
output = []
- #output.append(make_class_entry(
- # block, description=description,
- # ignored_methods=['make'], params=make_func.params))
+ output.append(make_class_entry(
+ block, description=description,
+ ignored_methods=['make'], params=make_func.params))
makename = block.name() + '::make'
output.append(make_func_entry(
make_func, name=makename, description=description,
diff --git a/docs/sphinx/gnuradio_sphinx.py b/docs/sphinx/gnuradio_sphinx.py
index f1e16481ba..8b52ed3ba6 100644
--- a/docs/sphinx/gnuradio_sphinx.py
+++ b/docs/sphinx/gnuradio_sphinx.py
@@ -132,7 +132,21 @@ common_block_members =[
'set_min_output_buffer',
'set_processor_affinity',
'symbol_name',
- 'unset_processor_affinity', ]
+ 'unset_processor_affinity',
+ 'disconnect_all',
+ 'index',
+ 'length',
+ 'lock',
+ 'primitive_connect',
+ 'primitive_disconnect',
+ 'primitive_message_port_register_hier_in',
+ 'primitive_message_port_register_hier_out',
+ 'primitive_msg_connect',
+ 'primitive_msg_disconnect',
+ 'to_hier_block2',
+ 'type',
+ 'unlock',
+]
class OldBlockDocumenter(FunctionDocumenter):
"""
diff --git a/docs/sphinx/source/gr/index.rst b/docs/sphinx/source/gr/index.rst
index 9ae25d38cf..cef9d560e2 100644
--- a/docs/sphinx/source/gr/index.rst
+++ b/docs/sphinx/source/gr/index.rst
@@ -26,7 +26,6 @@ Miscellaneous
gnuradio.gr.feval_ll
gnuradio.gr.feval
gnuradio.gr.prefs
- gnuradio.gr.test
gnuradio.gr.message
gnuradio.gr.msg_queue
gnuradio.gr.enable_realtime_scheduling
diff --git a/docs/sphinx/source/gr/misc.rst b/docs/sphinx/source/gr/misc.rst
index b0a3f3ba10..013f3fc53d 100644
--- a/docs/sphinx/source/gr/misc.rst
+++ b/docs/sphinx/source/gr/misc.rst
@@ -6,7 +6,6 @@ gnuradio.gr: Miscellaneous
.. autofunction:: gnuradio.gr.feval_ll
.. autofunction:: gnuradio.gr.feval
.. autofunction:: gnuradio.gr.prefs
-.. autofunction:: gnuradio.gr.test
.. autofunction:: gnuradio.gr.message
.. autofunction:: gnuradio.gr.msg_queue
.. autofunction:: gnuradio.gr.enable_realtime_scheduling
--
cgit v1.2.3