summaryrefslogtreecommitdiff
path: root/docs/doxygen
diff options
context:
space:
mode:
Diffstat (limited to 'docs/doxygen')
-rw-r--r--docs/doxygen/CMakeLists.txt2
-rw-r--r--docs/doxygen/Doxyfile.in13
-rw-r--r--docs/doxygen/other/build_guide.dox3
-rwxr-xr-xdocs/doxygen/other/doxypy.py56
-rw-r--r--docs/doxygen/other/group_defs.dox6
5 files changed, 27 insertions, 53 deletions
diff --git a/docs/doxygen/CMakeLists.txt b/docs/doxygen/CMakeLists.txt
index a837bd8e11..d22f9d9f62 100644
--- a/docs/doxygen/CMakeLists.txt
+++ b/docs/doxygen/CMakeLists.txt
@@ -74,4 +74,4 @@ add_custom_command(
add_custom_target(doxygen_target ALL DEPENDS ${BUILT_DIRS})
-install(DIRECTORY ${BUILT_DIRS} DESTINATION ${GR_PKG_DOC_DIR} COMPONENT "docs")
+install(DIRECTORY ${BUILT_DIRS} DESTINATION ${GR_PKG_DOC_DIR})
diff --git a/docs/doxygen/Doxyfile.in b/docs/doxygen/Doxyfile.in
index 8d06249abb..830bf54e9f 100644
--- a/docs/doxygen/Doxyfile.in
+++ b/docs/doxygen/Doxyfile.in
@@ -145,8 +145,6 @@ STRIP_FROM_INC_PATH = @CMAKE_SOURCE_DIR@/gnuradio-runtime/include \
@CMAKE_BINARY_DIR@/gnuradio-runtime/include \
@CMAKE_SOURCE_DIR@/gr-analog/include \
@CMAKE_BINARY_DIR@/gr-analog/include \
- @CMAKE_SOURCE_DIR@/gr-atsc/include \
- @CMAKE_BINARY_DIR@/gr-atsc/include \
@CMAKE_SOURCE_DIR@/gr-audio/include \
@CMAKE_BINARY_DIR@/gr-audio/include \
@CMAKE_SOURCE_DIR@/gr-blocks/include \
@@ -183,8 +181,6 @@ STRIP_FROM_INC_PATH = @CMAKE_SOURCE_DIR@/gnuradio-runtime/include \
@CMAKE_BINARY_DIR@/gr-vocoder/include \
@CMAKE_SOURCE_DIR@/gr-wavelet/include \
@CMAKE_BINARY_DIR@/gr-wavelet/include \
- @CMAKE_SOURCE_DIR@/gr-wxgui/include \
- @CMAKE_BINARY_DIR@/gr-wxgui/include \
@CMAKE_SOURCE_DIR@/gr-zeromq/include \
@CMAKE_BINARY_DIR@/gr-zeromq/include \
@CMAKE_SOURCE_DIR@/volk/include \
@@ -753,14 +749,10 @@ EXCLUDE = @abs_top_srcdir@/volk \
@abs_top_builddir@/gnuradio-runtime/python/gnuradio/gr/gr_threading.py \
@abs_top_builddir@/gnuradio-runtime/python/gnuradio/gr/gr_threading_23.py \
@abs_top_builddir@/gnuradio-runtime/python/gnuradio/gr/gr_threading_24.py \
- @abs_top_builddir@/gr-atsc/swig/atsc_swig.py \
- @abs_top_builddir@/gr-atsc/lib/gen_encoder.py \
- @abs_top_builddir@/gr-atsc/python \
@abs_top_builddir@/gr-pager/swig/pager_swig.py \
@abs_top_builddir@/gr-trellis/doc \
@abs_top_builddir@/gr-trellis/swig/trellis_swig.py \
@abs_top_builddir@/gr-video-sdl/swig/video_sdl_swig.py \
- @abs_top_builddir@/gr-wxgui/python \
@abs_top_builddir@/grc \
@abs_top_builddir@/_CPack_Packages \
@abs_top_srcdir@/cmake \
@@ -771,8 +763,6 @@ EXCLUDE = @abs_top_srcdir@/volk \
@abs_top_builddir@/gnuradio-runtime/lib \
@abs_top_srcdir@/gr-analog/lib \
@abs_top_builddir@/gr-analog/lib \
- @abs_top_srcdir@/gr-atsc/lib \
- @abs_top_builddir@/gr-atsc/lib \
@abs_top_srcdir@/gr-audio/lib \
@abs_top_builddir@/gr-audio/lib \
@abs_top_srcdir@/gr-blocks/lib \
@@ -821,8 +811,6 @@ EXCLUDE = @abs_top_srcdir@/volk \
@abs_top_builddir@/gr-vocoder/lib \
@abs_top_srcdir@/gr-wavelet/lib \
@abs_top_builddir@/gr-wavelet/lib \
- @abs_top_srcdir@/gr-wxgui/lib \
- @abs_top_builddir@/gr-wxgui/lib \
@abs_top_srcdir@/gr-zeromq/lib \
@abs_top_builddir@/gr-zeromq/lib \
@abs_top_srcdir@/volk/cmake/msvc \
@@ -846,7 +834,6 @@ EXCLUDE_PATTERNS = */.deps/* \
*/.svn/* \
*/CVS/* \
*/__init__.py \
- */gr-atsc/src/lib/Gr* \
*/moc_*.cc \
*/qa_*.cc \
*/qa_*.h \
diff --git a/docs/doxygen/other/build_guide.dox b/docs/doxygen/other/build_guide.dox
index f3bea608a4..bbcb7c7d4a 100644
--- a/docs/doxygen/other/build_guide.dox
+++ b/docs/doxygen/other/build_guide.dox
@@ -38,6 +38,7 @@ first. Most recent systems have these packages available.
\li boost (>= 1.35) http://www.boost.org/users/download/
\li cppunit (>= 1.9.14) http://freedesktop.org/wiki/Software/cppunit/
\li fftw3f (>= 3.0.1) http://www.fftw.org/download.html
+\li mako (>= 0.4.2) http://www.makotemplates.org/download.html
\subsection dep_python Python Wrappers
\li python (>= 2.5) http://www.python.org/download/
@@ -60,8 +61,6 @@ first. Most recent systems have these packages available.
\li qwt (>= 5.2.0) http://sourceforge.net/projects/qwt/
\li pyqt (>= 4.10.0) http://www.riverbankcomputing.co.uk/software/pyqt/download
-\subsection dep_gr_wxgui gr-wxgui: The WX-based Graphical User Interface
-\li wxpython (>= 2.8) http://www.wxpython.org/
\li python-lxml (>= 1.3.6) http://lxml.de/
\subsection dep_gr_audio gr-audio: Audio Subsystems (system/OS dependent)
diff --git a/docs/doxygen/other/doxypy.py b/docs/doxygen/other/doxypy.py
index 15d3e0824d..a9af32ab53 100755
--- a/docs/doxygen/other/doxypy.py
+++ b/docs/doxygen/other/doxypy.py
@@ -15,7 +15,7 @@ add the following lines to your Doxyfile:
INPUT_FILTER = "python /path/to/doxypy.py"
"""
-__version__ = "0.4.1"
+__version__ = "0.4.2"
__date__ = "5th December 2008"
__website__ = "http://code.foosel.org/doxypy"
@@ -42,7 +42,7 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
import sys
import re
-from optparse import OptionParser, OptionGroup
+from argparse import ArgumentParser
class FSM(object):
"""Implements a finite state machine.
@@ -85,7 +85,7 @@ class FSM(object):
self.current_state = to_state
self.current_input = input
self.current_transition = transition
- if options.debug:
+ if args.debug:
print >>sys.stderr, "# FSM: executing (%s -> %s) for line '%s'" % (from_state, to_state, input)
callback(match)
return
@@ -179,7 +179,7 @@ class Doxypy(object):
def __closeComment(self):
"""Appends any open comment block and triggering block to the output."""
- if options.autobrief:
+ if args.autobrief:
if len(self.comment) == 1 \
or (len(self.comment) > 2 and self.comment[1].strip() == ''):
self.comment[0] = self.__docstringSummaryToBrief(self.comment[0])
@@ -207,7 +207,7 @@ class Doxypy(object):
"""Flushes the current outputbuffer to the outstream."""
if self.output:
try:
- if options.debug:
+ if args.debug:
print >>sys.stderr, "# OUTPUT: ", self.output
print >>self.outstream, "\n".join(self.output)
self.outstream.flush()
@@ -227,7 +227,7 @@ class Doxypy(object):
Closes the current commentblock and starts a new comment search.
"""
- if options.debug:
+ if args.debug:
print >>sys.stderr, "# CALLBACK: resetCommentSearch"
self.__closeComment()
self.startCommentSearch(match)
@@ -238,7 +238,7 @@ class Doxypy(object):
Saves the triggering line, resets the current comment and saves
the current indentation.
"""
- if options.debug:
+ if args.debug:
print >>sys.stderr, "# CALLBACK: startCommentSearch"
self.defclass = [self.fsm.current_input]
self.comment = []
@@ -250,7 +250,7 @@ class Doxypy(object):
Closes the current commentblock, resets the triggering line and
appends the current line to the output.
"""
- if options.debug:
+ if args.debug:
print >>sys.stderr, "# CALLBACK: stopCommentSearch"
self.__closeComment()
@@ -262,7 +262,7 @@ class Doxypy(object):
Closes the open comment block, resets it and appends the current line.
"""
- if options.debug:
+ if args.debug:
print >>sys.stderr, "# CALLBACK: appendFileheadLine"
self.__closeComment()
self.comment = []
@@ -274,7 +274,7 @@ class Doxypy(object):
The comment delimiter is removed from multiline start and ends as
well as singleline comments.
"""
- if options.debug:
+ if args.debug:
print >>sys.stderr, "# CALLBACK: appendCommentLine"
(from_state, to_state, condition, callback) = self.fsm.current_transition
@@ -311,13 +311,13 @@ class Doxypy(object):
def appendNormalLine(self, match):
"""Appends a line to the output."""
- if options.debug:
+ if args.debug:
print >>sys.stderr, "# CALLBACK: appendNormalLine"
self.output.append(self.fsm.current_input)
def appendDefclassLine(self, match):
"""Appends a line to the triggering block."""
- if options.debug:
+ if args.debug:
print >>sys.stderr, "# CALLBACK: appendDefclassLine"
self.defclass.append(self.fsm.current_input)
@@ -378,37 +378,31 @@ class Doxypy(object):
self.fsm.makeTransition(line)
self.__flushBuffer()
-def optParse():
- """Parses commandline options."""
- parser = OptionParser(prog=__applicationName__, version="%prog " + __version__)
+def argParse():
+ """Parses commandline args."""
+ parser = ArgumentParser(prog=__applicationName__)
- parser.set_usage("%prog [options] filename")
- parser.add_option("--autobrief",
- action="store_true", dest="autobrief",
+ parser.add_argument("--version", action="version",
+ version="%(prog)s " + __version__
+ )
+ parser.add_argument("--autobrief", action="store_true",
help="use the docstring summary line as \\brief description"
)
- parser.add_option("--debug",
- action="store_true", dest="debug",
+ parser.add_argument("--debug", action="store_true",
help="enable debug output on stderr"
)
+ parser.add_argument("filename", metavar="FILENAME")
- ## parse options
- global options
- (options, filename) = parser.parse_args()
-
- if not filename:
- print >>sys.stderr, "No filename given."
- sys.exit(-1)
-
- return filename[0]
+ return parser.parse_args()
def main():
"""Starts the parser on the file given by the filename as the first
argument on the commandline.
"""
- filename = optParse()
+ global args
+ args = argParse()
fsm = Doxypy()
- fsm.parseFile(filename)
+ fsm.parseFile(args.filename)
if __name__ == "__main__":
main()
diff --git a/docs/doxygen/other/group_defs.dox b/docs/doxygen/other/group_defs.dox
index 8edc8ab5ef..fecde8c9c6 100644
--- a/docs/doxygen/other/group_defs.dox
+++ b/docs/doxygen/other/group_defs.dox
@@ -57,7 +57,6 @@
/*! \defgroup uhd_blk UHD Interface */
/*! \defgroup waveform_generators_blk Waveform Generators */
/*! \defgroup wavelet_blk Wavelet Transforms */
-/*! \defgroup wxgui_blk WX Graphical Interfaces */
/*!
* \defgroup base_blk Base classes for GR Blocks
@@ -78,11 +77,6 @@
*/
/*!
- * \defgroup atsc ATSC
- * ATSC Applications...
- */
-
-/*!
* \defgroup pager Pager
* Pager Applications
*/
generated by cgit v1.2.3 (git 2.39.1) at 2025-03-21 22:34:45 +0000