Changeset 7509

Timestamp:

01/25/08 07:33:00

Author:

jcorgan

Message:

Applied changeset r7445 on trunk to release branch.

Files:

• gnuradio/branches/releases/3.1/gnuradio-core/doc/Doxyfile.in (modified) (28 diffs)
• gnuradio/branches/releases/3.1/gnuradio-core/doc/other/Makefile.am (modified) (1 diff)
• gnuradio/branches/releases/3.1/gnuradio-core/doc/other/doxypy.py (copied) (copied from gnuradio/trunk/gnuradio-core/doc/other/doxypy.py)
• gnuradio/branches/releases/3.1/gnuradio-core/doc/other/group_defs.dox (modified) (2 diffs)

gnuradio/branches/releases/3.1/gnuradio-core/doc/Doxyfile.in

@@ -1 @@
-4.1
+5.3
-
-# This file describes the settings to be used by the documentation system
@@ -15 +15 @@
-#---------------------------------------------------------------------------
-
+# This tag specifies the encoding used for all characters in the config file that 
+# follow. The default is UTF-8 which is also the encoding used for all text before 
+# the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into 
+# libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of 
+# possible encodings.
+
+DOXYFILE_ENCODING      = UTF-8
+
-# The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
-# by quotes) that should identify the project.
@@ -46 +54 @@
-# information to generate all constant output in the proper language. 
-# The default language is English, other supported languages are: 
-Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish
-Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese
-Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegi
-Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish
-
+Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional
+Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian
+Italian, Japanese, Japanese-en (Japanese with English messages), Kore
+Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian
+erbian, Slovak, Slovene, Spanish, S
-
-OUTPUT_LANGUAGE        = English
-
-# This tag can be used to specify the encoding used in the generated output. 
-# The encoding is not always determined by the language that is chosen, 
-# but also whether or not the output is meant for Windows or non-Windows users. 
-# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES 
-# forces the Windows encoding (this is the default for the Windows binary), 
-# whereas setting the tag to NO uses a Unix-style encoding (the default for 
-# all platforms other than Windows).
-
-USE_WINDOWS_ENCODING   = NO
-
-# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 
@@ -136 +134 @@
-# will interpret the first line (until the first dot) of a JavaDoc-style 
-# comment as the brief description. If set to NO, the JavaDoc 
-the Qt-style comments (thus requiring an
-explicit @brief command for a brief description.
+regular Qt-style comments
+(thus requiring an explicit @brief command for a brief description.)
-
-JAVADOC_AUTOBRIEF      = NO
+
+# If the QT_AUTOBRIEF tag is set to YES then Doxygen will 
+# interpret the first line (until the first dot) of a Qt-style 
+# comment as the brief description. If set to NO, the comments 
+# will behave just like regular Qt-style comments (thus requiring 
+# an explicit \brief command for a brief description.)
+
+QT_AUTOBRIEF           = NO
-
-# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 
@@ -162 +168 @@
-INHERIT_DOCS           = YES
-
-
-
-
-
-
-
+
+
+
+
+
-
-# The TAB_SIZE tag can be used to set the number of spaces in a tab. 
@@ -190 +195 @@
-OPTIMIZE_OUTPUT_FOR_C  = NO
-
-sources 
-
+
+sources 
-# For instance, namespaces will be presented as packages, qualified scopes 
-# will look different, etc.
-
-OPTIMIZE_OUTPUT_JAVA   = NO
+
+# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to 
+# include (a tag file for) the STL sources as input, then you should 
+# set this tag to YES in order to let doxygen match functions declarations and 
+# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 
+# func(std::string) {}). This also make the inheritance and collaboration 
+# diagrams that involve STL classes more complete and accurate.
+
+BUILTIN_STL_SUPPORT    = YES
+
+# If you use Microsoft's C++/CLI language, you should set this option to YES to
+# enable parsing support.
+
+CPP_CLI_SUPPORT        = NO
+
+# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
+# tag is set to YES, then doxygen will reuse the documentation of the first 
+# member in the group (if any) for the other members of the group. By default 
+# all members of a group must be documented explicitly.
+
+DISTRIBUTE_GROUP_DOC   = NO
-
-# Set the SUBGROUPING tag to YES (the default) to allow class member groups of 
@@ -238 +264 @@
-
-EXTRACT_LOCAL_METHODS  = NO
+
+# If this flag is set to YES, the members of anonymous namespaces will be extracted 
+# and appear in the documentation as a namespace called 'anonymous_namespace{file}', 
+# where file will be replaced with the base name of the file that contains the anonymous 
+# namespace. By default anonymous namespace are hidden.
+
+EXTRACT_ANON_NSPACES   = NO
-
-# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 
@@ -371 +404 @@
-# If the sources in your project are distributed over multiple directories 
-# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 
-
-
-
-
+
+
+
-
-# The FILE_VERSION_FILTER tag can be used to specify a program or script that 
@@ -381 +413 @@
-# popen()) the command <command> <input-file>, where <command> is the value of 
-# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 
-
+r
-# is used as the file version. See the manual for examples.
-
@@ -429 +461 @@
-# be obtained via FILE_VERSION_FILTER)
-
-
+  
-
-# The WARN_LOGFILE tag can be used to specify a file to which warning 
@@ -447 +479 @@
-
-INPUT                  = @top_srcdir@
+
+# This tag can be used to specify the character encoding of the source files that 
+# doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default 
+# input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding. 
+# See http://www.gnu.org/software/libiconv for the list of possible encodings.
+
+INPUT_ENCODING         = UTF-8
-
-# If the value of the INPUT tag contains directories, you can use the 
@@ -453 +492 @@
-# blank the following patterns are tested: 
-# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 
-
+ *.py
-
-FILE_PATTERNS          = *.h \
-cc
-dox
+dox
+py
-
-# The RECURSIVE tag can be used to turn specify whether or not subdirectories 
@@ -469 +508 @@
-# subdirectory from a directory tree whose root is specified with the INPUT tag.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-# The EXCLUDE_SYMLINKS tag can be used select whether or not files or 
@@ -500 +599 @@
-# If the value of the INPUT tag contains directories, you can use the 
-# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-# The EXAMPLE_PATH tag can be used to specify one or more files or 
@@ -547 +670 @@
-# is applied to all files.
-
-
-
-
+
+
+
+
-# INPUT_FILTER) will be used to filter the input files when producing source 
-# files to browse (i.e. when SOURCE_BROWSER is set to YES).
-
-NO
+YES
-
-#---------------------------------------------------------------------------
@@ -562 +686 @@
-# be generated. Documented entities will be cross-referenced with these sources. 
-# Note: To get rid of all source code in the generated output, make sure also 
-
+
+
+
-
-SOURCE_BROWSER         = NO
@@ -588 +714 @@
-
-REFERENCES_RELATION    = YES
+
+# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
+# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
+# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
+# link to the source code.  Otherwise they will link to the documentstion.
+
+REFERENCES_LINK_SOURCE = YES
+
+# If the USE_HTAGS tag is set to YES then the references to source code 
+# will point to the HTML generated by the htags(1) tool instead of doxygen 
+# built-in source browser. The htags tool is part of GNU's global source 
+# tagging system (see http://www.gnu.org/software/global/global.html). You 
+# will need version 4.8.6 or higher.
+
+USE_HTAGS              = NO
-
-# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
@@ -673 +814 @@
-GENERATE_HTMLHELP      = NO
-
+# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 
+# documentation will contain sections that can be hidden and shown after the 
+# page has loaded. For this to work a browser that supports 
+# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox 
+# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
+
+HTML_DYNAMIC_SECTIONS  = NO
+
-# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 
-# be used to specify the file name of the resulting .chm file. You 
@@ -737 +886 @@
-# generate Latex output.
-
-# -eb
-GENERATE_LATEX         = NO
-
@@ -885 +1033 @@
-# the code including all documentation.
-
-YES
+NO
-
-# The XML_OUTPUT tag is used to specify where the XML pages will be put. 
@@ -910 +1058 @@
-# enabling this will significantly increase the size of the XML output.
-
-# -eb
-XML_PROGRAMLISTING     = NO
-
@@ -977 +1124 @@
-# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 
-# then the macro expansion is limited to the macros specified with the 
-PRE
+
-
-EXPAND_ONLY_PREDEF     = NO
@@ -1080 +1227 @@
-CLASS_DIAGRAMS         = YES
-
+# You can define message sequence charts within doxygen comments using the \msc 
+# command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to 
+# produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to 
+# specify the directory where the mscgen tool resides. If left empty the tool is assumed to 
+# be found in the default search path.
+
+MSCGEN_PATH            = 
+
-# If set to YES, the inheritance and collaboration graphs will hide 
-# inheritance and usage relations if the target is undocumented 
@@ -1137 +1292 @@
-INCLUDED_BY_GRAPH      = YES
-
-
+, SOURCE_BROWSER
-# generate a call dependency graph for every global function or class method. 
-# Note that enabling this option will significantly increase the time of a run. 
@@ -1145 +1300 @@
-CALL_GRAPH             = NO
-
+# If the CALLER_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will 
+# generate a caller dependency graph for every global function or class method. 
+# Note that enabling this option will significantly increase the time of a run. 
+# So in most cases it will be better to enable caller graphs for selected 
+# functions only using the \callergraph command.
+
+CALLER_GRAPH           = NO
+
-# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 
-# will graphical hierarchy of all classes instead of a textual one.
@@ -1174 +1337 @@
-DOTFILE_DIRS           = 
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
-
-# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 
@@ -1195 +1352 @@
-# that lay further from the root node will be omitted. Note that setting this 
-# option to 1 or 2 may greatly reduce the computation time needed for large 
-
-
-
-
+
+
-
-MAX_DOT_GRAPH_DEPTH    = 0
@@ -1215 +1370 @@
-# support this, this feature is disabled by default.
-
-# -eb
-DOT_MULTI_TARGETS      = YES
-

gnuradio/branches/releases/3.1/gnuradio-core/doc/other/Makefile.am

@@ -23 +23 @@
-
-EXTRA_DIST = \
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+

gnuradio/branches/releases/3.1/gnuradio-core/doc/other/group_defs.dox

@@ -1 +1 @@
-/*!
- * \defgroup block Signal Processing Blocks
-, blah, blah blah
+
- * @{
- */
@@ -23 +23 @@
- */
-
+/*!
+ * \defgroup level Signal Level Control
+ */
+
+/*!
+ * \defgroup clock Signal Clock Synchronization
+ */
+
-/*! @} */
-
-
-filter_primitive Filter Primitives
+Digital 
+graphical Graphical Utilities    
-/*! \defgroup internal Implementation Details           */
-
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+/*!
+ * \defgroup radar Radar
+ * Radar Applications...
+ */
+
+/*!
+ * \defgroup atsc ATSC
+ * ATSC Applications...
+ */
+
+/*!
+ * \defgroup pager Pager 
+ * Pager Applications
+ */
+
+/*!
+ * \defgroup sounder    Sounder
+ * Channel Sounder
+ */
+
+/*! @} */
+
+/*! \defgroup usrp USRP */