Blocked revisions 409762
[asterisk/asterisk.git] / contrib / asterisk-ng-doxygen
index 29575f6..51a3f5d 100644 (file)
@@ -1,4 +1,4 @@
-# Doxyfile 1.5.2
+# Doxyfile 1.7.1
 
 # This file describes the settings to be used by the documentation system
 # doxygen (www.doxygen.org) for a project
@@ -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
@@ -179,8 +179,8 @@ TAB_SIZE               = 3
 # will result in a user-defined paragraph with heading "Side Effects:".
 # You can put \n's in the value part of an alias to insert newlines.
 
-ALIASES                = "extref=\xrefitem extref \"ExtRef\" \"External references\""
-ALIASES += "AsteriskTrunkWarning=\note The information contained on this page may be out of date.  To make sure you get the most current information, please make sure that you are using the documentation generated from Asterisk trunk."
+ALIASES                = "extref=\xrefitem extref \"ExtRef\" \"External references\"" \
+                         "AsteriskTrunkWarning=\note The information contained on this page may be out of date.  To make sure you get the most current information, please make sure that you are using the documentation generated from Asterisk trunk."
 
 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
 # sources only. Doxygen will then generate output that is more tailored for C.
@@ -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
@@ -661,9 +646,10 @@ EXCLUDE_SYMBOLS        =
 # directories that contain example code fragments that are included (see
 # the \include command).
 
-EXAMPLE_PATH           = ./ \
+EXAMPLE_PATH           = . \
                          doc \
-                         configs
+                         configs \
+                         contrib
 
 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
@@ -805,7 +791,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 +803,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
@@ -1049,7 +1035,7 @@ ENUM_VALUES_PER_LINE   = 4
 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
 # Windows users are probably better off using the HTML help feature.
 
-GENERATE_TREEVIEW      = YES
+GENERATE_TREEVIEW      = NO
 
 # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
 # and Class Hierarchy pages using a tree view instead of an ordered list.
@@ -1244,7 +1230,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 +1359,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,61 +1378,59 @@ 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.
 # The macro definition that is found in the sources will be used.
 # Use the PREDEFINED tag if you want to use a different macro definition.
 
-EXPAND_AS_DEFINED      = \
-            AST_INLINE_API \
-            AST_DECLARE_STRING_FIELDS \
-            AST_STRING_FIELD \
-            AST_THREADSTORAGE \
-            AST_THREADSTORAGE_CUSTOM \
-            AST_MODULE_INFO \
-            AST_MODULE_INFO_STANDARD \
-            __AST_MUTEX_DEFINE \
-            AST_MUTEX_DEFINE_STATIC \
-            AST_MUTEX_DEFINE_STATIC_NOTRACKING \
-            __AST_RWLOCK_DEFINE \
-            AST_RWLOCK_DEFINE_STATIC \
-            AST_LIST_HEAD \
-            AST_RWLIST_HEAD \
-            AST_LIST_HEAD_NOLOCK \
-            AST_LIST_HEAD_STATIC \
-            AST_RWLIST_HEAD_STATIC \
-            AST_LIST_HEAD_NOLOCK_STATIC \
-            AST_LIST_ENTRY \
-            AST_RWLIST_ENTRY \
-            __ASTOBJ_HASH \
-            ASTOBJ_COMPONENTS_NOLOCK_FULL \
-            ASTOBJ_COMPONENTS_NOLOCK \
-            ASTOBJ_COMPONENTS_FULL \
-            ASTOBJ_COMPONENTS \
-            AST_IVR_DECLARE_MENU \
-            AST_DECLARE_APP_ARGS \
-            AST_DEFINE_APP_ARGS_TYPE \
-            AST_APP_ARG \
-            BEGIN_OPTIONS \
-            END_OPTIONS \
-            AST_APP_OPTIONS \
-            AST_APP_OPTION \
-            AST_APP_OPTION_ARG \
-            AST_DLLIST_HEAD \
-            AST_DLLIST_HEAD_STATIC \
-            AST_DLLIST_HEAD_NOLOCK \
-            AST_DLLIST_HEAD_NOLOCK_STATIC \
-            AST_RWDLLIST_HEAD \
-            AST_RWDLLIST_HEAD_STATIC \
-            AST_DLLIST_ENTRY \
-            AST_RWDLLIST_ENTRY \
-            AST_CLI_DEFINE \
-            AST_OPTIONAL_API \
-            AST_OPTIONAL_API_ATTR
+EXPAND_AS_DEFINED      = AST_INLINE_API \
+                         AST_DECLARE_STRING_FIELDS \
+                         AST_STRING_FIELD \
+                         AST_THREADSTORAGE \
+                         AST_THREADSTORAGE_CUSTOM \
+                         AST_MODULE_INFO \
+                         AST_MODULE_INFO_STANDARD \
+                         __AST_MUTEX_DEFINE \
+                         AST_MUTEX_DEFINE_STATIC \
+                         AST_MUTEX_DEFINE_STATIC_NOTRACKING \
+                         __AST_RWLOCK_DEFINE \
+                         AST_RWLOCK_DEFINE_STATIC \
+                         AST_LIST_HEAD \
+                         AST_RWLIST_HEAD \
+                         AST_LIST_HEAD_NOLOCK \
+                         AST_LIST_HEAD_STATIC \
+                         AST_RWLIST_HEAD_STATIC \
+                         AST_LIST_HEAD_NOLOCK_STATIC \
+                         AST_LIST_ENTRY \
+                         AST_RWLIST_ENTRY \
+                         __ASTOBJ_HASH \
+                         ASTOBJ_COMPONENTS_NOLOCK_FULL \
+                         ASTOBJ_COMPONENTS_NOLOCK \
+                         ASTOBJ_COMPONENTS_FULL \
+                         ASTOBJ_COMPONENTS \
+                         AST_IVR_DECLARE_MENU \
+                         AST_DECLARE_APP_ARGS \
+                         AST_DEFINE_APP_ARGS_TYPE \
+                         AST_APP_ARG \
+                         BEGIN_OPTIONS \
+                         END_OPTIONS \
+                         AST_APP_OPTIONS \
+                         AST_APP_OPTION \
+                         AST_APP_OPTION_ARG \
+                         AST_DLLIST_HEAD \
+                         AST_DLLIST_HEAD_STATIC \
+                         AST_DLLIST_HEAD_NOLOCK \
+                         AST_DLLIST_HEAD_NOLOCK_STATIC \
+                         AST_RWDLLIST_HEAD \
+                         AST_RWDLLIST_HEAD_STATIC \
+                         AST_DLLIST_ENTRY \
+                         AST_RWDLLIST_ENTRY \
+                         AST_CLI_DEFINE \
+                         AST_OPTIONAL_API \
+                         AST_OPTIONAL_API_ATTR
 
 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
 # doxygen's preprocessor will remove all function-like macros that are alone