Doxygen Updates Janitor Work

* Whitespace, doc-blocks, spelling, case, missing and incorrect tags. * Add cleanup to Makefile for the Doxygen configuration update * Start updating Doxygen configuration for cleaner output * Enable inclusion of configuration files into documentation * remove mantisworkflow... * update documentation README * Add markup to Tilghman's email and talk with him about updating his email, he knows... * no code changes on this commit other than the mentioned Makefile change (issue ASTERISK-20259) git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@373384 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2025-10-12 15:45:18 +00:00 · 2012-09-22 20:43:30 +00:00
parent ca8aeeef1b
commit fd98835f1f
30 changed files with 143 additions and 361 deletions
--- a/contrib/asterisk-ng-doxygen
+++ b/contrib/asterisk-ng-doxygen
@@ -38,7 +38,7 @@ PROJECT_NUMBER         =
 # If a relative path is entered, it will be relative to the location
 # where doxygen was started. If left blank the current directory will be used.

-OUTPUT_DIRECTORY       = doc/api
+OUTPUT_DIRECTORY       = doc

 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
 # 4096 sub-directories (in 2 levels) under the output directory of each output
@@ -47,7 +47,7 @@ OUTPUT_DIRECTORY       = doc/api
 # source files, where putting all generated files in the same directory would
 # otherwise cause performance problems for the file system.

-CREATE_SUBDIRS         = NO
+CREATE_SUBDIRS         = YES

 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
 # documentation generated by doxygen is written. Doxygen will use this
@@ -301,7 +301,7 @@ SYMBOL_CACHE_SIZE      = 0

 EXTRACT_ALL            = YES

-# If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
+# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
 # will be included in the documentation.

 EXTRACT_PRIVATE        = NO
@@ -548,12 +548,12 @@ WARN_IF_UNDOCUMENTED   = YES
 # parameters in a documented function, or documenting parameters that
 # don't exist or using markup commands wrongly.

-WARN_IF_DOC_ERROR      = YES
+WARN_IF_DOC_ERROR      = NO

-# This WARN_NO_PARAMDOC option can be abled to get warnings for 
-# functions that are documented, but have no documentation for their parameters 
-# or return value. If set to NO (the default) doxygen will only warn about 
-# wrong or incomplete parameter documentation, but not about the absence of 
+# This WARN_NO_PARAMDOC option can be abled to get warnings for
+# functions that are documented, but have no documentation for their parameters
+# or return value. If set to NO (the default) doxygen will only warn about
+# wrong or incomplete parameter documentation, but not about the absence of
 # documentation.

 WARN_NO_PARAMDOC       = NO
@@ -571,7 +571,7 @@ WARN_FORMAT            =
 # and error messages should be written. If left blank the output is written
 # to stderr.

-WARN_LOGFILE           =
+WARN_LOGFILE           = doxygen.log

 #---------------------------------------------------------------------------
 # configuration options related to the input files
@@ -582,27 +582,7 @@ WARN_LOGFILE           =
 # directories like "/usr/src/myproject". Separate the files or directories
 # with spaces.

-INPUT                  = ./ \
-                         agi \
-                         apps \
-                         bridges \
-                         cdr \
-                         channels \
-                         channels/sip \
-                         channels/misdn \
-                         codecs \
-                         formats \
-                         funcs \
-                         include \
-                         include/asterisk \
-                         include/asterisk/doxygen \
-                         main \
-                         main/stdtime \
-                         pbx \
-                         res \
-                         res/ael \
-                         res/ais \
-                         res/snmp
+INPUT                  =

 # 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
@@ -627,13 +607,16 @@ FILE_PATTERNS          = *.c \
 # should be searched for input files as well. Possible values are YES and NO.
 # If left blank NO is used.

-RECURSIVE              = NO
+RECURSIVE              = yes

 # The EXCLUDE tag can be used to specify files and/or directories that should
 # excluded from the INPUT source files. This way you can easily exclude a
 # subdirectory from a directory tree whose root is specified with the INPUT tag.

-EXCLUDE                = 
+EXCLUDE                = doc/api \
+                         menuselect \
+                         res/pjproject \
+                         addons/ooh323c/src

 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
 # directories that are symbolic links (a Unix filesystem feature) are excluded
@@ -647,7 +630,9 @@ EXCLUDE_SYMLINKS       = YES
 # against the file with absolute path, so to exclude all test directories
 # for example use the pattern */test/*

-EXCLUDE_PATTERNS       = 
+EXCLUDE_PATTERNS       = *.o \
+                         *.o.d \
+                         .*

 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
 # (namespaces, classes, functions, etc.) that should be excluded from the
@@ -677,7 +662,7 @@ EXAMPLE_PATTERNS       =
 # commands irrespective of the value of the RECURSIVE tag.
 # Possible values are YES and NO. If left blank NO is used.

-EXAMPLE_RECURSIVE      = NO
+EXAMPLE_RECURSIVE      = YES

 # The IMAGE_PATH tag can be used to specify one or more files or
 # directories that contain image that are included in the documentation (see
@@ -805,7 +790,7 @@ GENERATE_HTML          = YES
 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
 # put in front of it. If left blank `html' will be used as the default path.

-HTML_OUTPUT            = 
+HTML_OUTPUT            = api

 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for
 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank
@@ -817,7 +802,7 @@ HTML_FILE_EXTENSION    = .html
 # each generated HTML page. If it is left blank doxygen will generate a
 # standard header.

-HTML_HEADER            = contrib/asterisk-doxygen-header
+HTML_HEADER            =

 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
 # each generated HTML page. If it is left blank doxygen will generate a
@@ -1244,7 +1229,7 @@ GENERATE_MAN           = NO
 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
 # put in front of it. If left blank `man' will be used as the default path.

-MAN_OUTPUT             = 
+MAN_OUTPUT             =

 # The MAN_EXTENSION tag determines the extension that is added to
 # the generated man pages (default is the subroutine's section .3)
@@ -1373,7 +1358,9 @@ SEARCH_INCLUDES        = YES
 # contain include files that are not input files but should be processed by
 # the preprocessor.

-INCLUDE_PATH           = include/ include/asterisk/
+INCLUDE_PATH           = ./ \
+                         include/ \
+                         include/asterisk/

 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
 # patterns (like *.h and *.hpp) to filter out the header-files in the
@@ -1390,9 +1377,8 @@ INCLUDE_FILE_PATTERNS  =
 # undefined via #undef or recursively expanded use the := operator
 # instead of the = operator.

-PREDEFINED             = \
-            __GNUC__ \
-            __attribute__(x)=
+PREDEFINED             = __GNUC__ \
+                         __attribute__(x)=

 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
 # this tag can be used to specify a list of macro names that should be expanded.