Changeset 4668

Timestamp:

08/11/07 16:09:42 (6 years ago)

Author:

jgaeddert

Message:

improving documentation, autofoo, readability of AutomaticGainControl? component

Location:

components/AutomaticGainControl/trunk/AutomaticGainControl

Files:

• Doxyfile (modified) (12 diffs)
• Makefile.am (modified) (2 diffs)
• configure.ac (modified) (1 diff)
• documentation.txt (modified) (2 diffs)
• genDocs.py (added)
• src (added)
• src/AutomaticGainControl.cpp (moved) (moved from components/AutomaticGainControl/trunk/AutomaticGainControl/AutomaticGainControl.cpp)
• src/AutomaticGainControl.h (moved) (moved from components/AutomaticGainControl/trunk/AutomaticGainControl/AutomaticGainControl.h)
• src/main.cpp (moved) (moved from components/AutomaticGainControl/trunk/AutomaticGainControl/main.cpp)
• xml (added)
• xml/AutomaticGainControl.prf.xml (moved) (moved from components/AutomaticGainControl/trunk/AutomaticGainControl/AutomaticGainControl.prf.xml)
• xml/AutomaticGainControl.scd.xml (moved) (moved from components/AutomaticGainControl/trunk/AutomaticGainControl/AutomaticGainControl.scd.xml)
• xml/AutomaticGainControl.spd.xml (moved) (moved from components/AutomaticGainControl/trunk/AutomaticGainControl/AutomaticGainControl.spd.xml)

components/AutomaticGainControl/trunk/AutomaticGainControl/Doxyfile

@@ -1 @@
-# Doxyfile 1.4.6
+# Doxyfile 1.5.2
 
 # 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.
@@ -31 +39 @@
 # where doxygen was started. If left blank the current directory will be used.
 
-OUTPUT_DIRECTORY       = docs
+OUTPUT_DIRECTORY       = documentation
 
 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 
@@ -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, Norwegian, 
-# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, 
-# Swedish, and Ukrainian.
+# Afrikaans, Arabic, 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, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian, 
+# Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
 
 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 
@@ -205 +203 @@
 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 
@@ -464 +467 @@
                          AutomaticGainControl.cpp
 
+# 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 
 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
@@ -498 +508 @@
 
 EXCLUDE_PATTERNS       = 
+
+# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 
+# (namespaces, classes, functions, etc.) that should be excluded from the output. 
+# The symbol name can be a fully qualified name, a word, or if the wildcard * is used, 
+# a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test
+
+EXCLUDE_SYMBOLS        = 
 
 # The EXAMPLE_PATH tag can be used to specify one or more files or 
@@ -584 +601 @@
 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 
@@ -661 +685 @@
 # stylesheet in the HTML output directory as well, or it will be erased!
 
-HTML_STYLESHEET        =
+HTML_STYLESHEET        = 
 
 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 
@@ -1081 +1105 @@
 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 
@@ -1146 +1178 @@
 CALL_GRAPH             = NO
 
+# If the CALLER_GRAPH 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.
@@ -1175 +1215 @@
 DOTFILE_DIRS           = 
 
-# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width 
-# (in pixels) of the graphs generated by dot. If a graph becomes larger than 
-# this value, doxygen will try to truncate the graph, so that it fits within 
-# the specified constraint. Beware that most browsers cannot cope with very 
-# large images.
-
-MAX_DOT_GRAPH_WIDTH    = 1024
-
-# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height 
-# (in pixels) of the graphs generated by dot. If a graph becomes larger than 
-# this value, doxygen will try to truncate the graph, so that it fits within 
-# the specified constraint. Beware that most browsers cannot cope with very 
-# large images.
-
-MAX_DOT_GRAPH_HEIGHT   = 1024
-
-# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 
-# graphs generated by dot. A depth value of 3 means that only nodes reachable 
-# from the root by following a path via at most 3 edges will be shown. Nodes 
-# 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 
-# code bases. Also note that a graph may be further truncated if the graph's 
-# image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH 
-# and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default), 
-# the graph is not depth-constrained.
-
-MAX_DOT_GRAPH_DEPTH    = 0
+# The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 
+# nodes that will be shown in the graph. If the number of nodes in a graph 
+# becomes larger than this value, doxygen will truncate the graph, which is 
+# visualized by representing a node as a red box. Note that doxygen will always 
+# show the root nodes and its direct children regardless of this setting.
+
+DOT_GRAPH_MAX_NODES    = 50
 
 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 

components/AutomaticGainControl/trunk/AutomaticGainControl/Makefile.am

@@ -4 +4 @@
 
 AutomaticGainControl_SOURCES =          \
-    AutomaticGainControl.cpp            \
-    AutomaticGainControl.h              \
-    main.cpp
+    src/AutomaticGainControl.cpp        \
+    src/AutomaticGainControl.h          \
+    src/main.cpp
 
 ossieName = AutomaticGainControl
@@ -13 +13 @@
 
 dist_xml_DATA =                         \
-    AutomaticGainControl.prf.xml        \
-    AutomaticGainControl.scd.xml        \
-    AutomaticGainControl.spd.xml
+    xml/AutomaticGainControl.prf.xml    \
+    xml/AutomaticGainControl.scd.xml    \
+    xml/AutomaticGainControl.spd.xml
 
+# ---------- documentation ---------
+
+# make sure "make docs" doesn't conflict with
+# separate docs/ directory
+.PHONY: docs documentation
+
+docs :
+        ./genDocs.py
+
+

components/AutomaticGainControl/trunk/AutomaticGainControl/configure.ac

@@ -35 +35 @@
 LIBS="$LIBS $OSSIE_LIBS"
 
-AC_SUBST(SI_PATH)
-
 AC_CONFIG_FILES(Makefile)
 

components/AutomaticGainControl/trunk/AutomaticGainControl/documentation.txt

@@ +1 @@
+/****************************************************************************
+
+Copyright 2006 Virginia Polytechnic Institute and State University
+
+This file is part of the OSSIE AutomaticGainControl.
+
+OSSIE AutomaticGainControl 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 2 of the License, or
+(at your option) any later version.
+
+OSSIE AutomaticGainControl 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 OSSIE AutomaticGainControl; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+****************************************************************************/
+
 /*! \mainpage Automatic Gain Control
 
@@ -53 +75 @@
 
 \section dependencies Software build dependencies
-The AGC component relies on the AutomaticGainControl class in SigProc, the
-OSSIE signal processing library.  It also relies on the standard iterfaces
-complexShort uses and provides ports descriptions.
+The AGC component relies on the AutomaticGainControl class in
+<a href="http://ossie-dev.mprg.org:8080/repos/ossie/browser/SigProc/trunk/SigProc">
+SigProc</a>, the OSSIE signal processing library.  It also relies on the standard
+iterfaces complexShort uses and provides ports descriptions.
 
 \section algorithm Detailed Description of Algorithm