|
|
|
|
@ -1,4 +1,4 @@
|
|
|
|
|
# Doxyfile 1.4.2
|
|
|
|
|
# Doxyfile 1.5.2
|
|
|
|
|
|
|
|
|
|
# This file describes the settings to be used by the documentation system
|
|
|
|
|
# doxygen (www.doxygen.org) for a project
|
|
|
|
|
@ -14,11 +14,24 @@
|
|
|
|
|
# Project related configuration options
|
|
|
|
|
#---------------------------------------------------------------------------
|
|
|
|
|
|
|
|
|
|
# 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.
|
|
|
|
|
|
|
|
|
|
PROJECT_NAME = "Asterisk - the Open Source PBX"
|
|
|
|
|
|
|
|
|
|
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
|
|
|
|
|
# This could be handy for archiving the generated documentation or
|
|
|
|
|
# if some version control system is used.
|
|
|
|
|
|
|
|
|
|
PROJECT_NUMBER =
|
|
|
|
|
|
|
|
|
|
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
|
|
|
|
|
# base path where the generated documentation will be put.
|
|
|
|
|
@ -40,24 +53,14 @@ CREATE_SUBDIRS = NO
|
|
|
|
|
# documentation generated by doxygen is written. Doxygen will use this
|
|
|
|
|
# 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
|
|
|
|
|
# include brief member descriptions after the members that are listed in
|
|
|
|
|
# the file and class documentation (similar to JavaDoc).
|
|
|
|
|
@ -156,13 +159,6 @@ DETAILS_AT_TOP = NO
|
|
|
|
|
|
|
|
|
|
INHERIT_DOCS = YES
|
|
|
|
|
|
|
|
|
|
# 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
|
|
|
|
|
|
|
|
|
|
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
|
|
|
|
|
# a new page for each member. If set to NO, the documentation of a member will
|
|
|
|
|
# be part of the file/class/namespace that contains it.
|
|
|
|
|
@ -181,7 +177,7 @@ 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 = "extref=\xrefitem extref \"ExtRef\" \"External references\""
|
|
|
|
|
|
|
|
|
|
# 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.
|
|
|
|
|
@ -190,13 +186,34 @@ ALIASES += "extref=\xrefitem extref \"ExtRef\" \"External references\""
|
|
|
|
|
|
|
|
|
|
OPTIMIZE_OUTPUT_FOR_C = YES
|
|
|
|
|
|
|
|
|
|
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
|
|
|
|
|
# only. Doxygen will then generate output that is more tailored for Java.
|
|
|
|
|
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
|
|
|
|
|
# sources only. Doxygen will then generate output that is more tailored for Java.
|
|
|
|
|
# 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 = NO
|
|
|
|
|
|
|
|
|
|
# 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
|
|
|
|
|
# the same type (for instance a group of public functions) to be put as a
|
|
|
|
|
# subgroup of that type (e.g. under the Public Functions section). Set it to
|
|
|
|
|
@ -371,7 +388,7 @@ SHOW_USED_FILES = YES
|
|
|
|
|
|
|
|
|
|
# If the sources in your project are distributed over multiple directories
|
|
|
|
|
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
|
|
|
|
|
# in the documentation.
|
|
|
|
|
# in the documentation. The default is NO.
|
|
|
|
|
|
|
|
|
|
SHOW_DIRECTORIES = YES
|
|
|
|
|
|
|
|
|
|
@ -380,7 +397,7 @@ SHOW_DIRECTORIES = YES
|
|
|
|
|
# version control system). Doxygen will invoke the program by executing (via
|
|
|
|
|
# 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
|
|
|
|
|
# provided by doxygen. Whatever the progam writes to standard output
|
|
|
|
|
# provided by doxygen. Whatever the program writes to standard output
|
|
|
|
|
# is used as the file version. See the manual for examples.
|
|
|
|
|
|
|
|
|
|
FILE_VERSION_FILTER =
|
|
|
|
|
@ -446,27 +463,34 @@ WARN_LOGFILE =
|
|
|
|
|
# with spaces.
|
|
|
|
|
|
|
|
|
|
INPUT = ./ \
|
|
|
|
|
main \
|
|
|
|
|
include \
|
|
|
|
|
main \
|
|
|
|
|
include \
|
|
|
|
|
include/asterisk \
|
|
|
|
|
channels \
|
|
|
|
|
channels/misdn \
|
|
|
|
|
funcs \
|
|
|
|
|
main/stdtime \
|
|
|
|
|
apps \
|
|
|
|
|
cdr \
|
|
|
|
|
codecs \
|
|
|
|
|
formats \
|
|
|
|
|
pbx \
|
|
|
|
|
agi \
|
|
|
|
|
res
|
|
|
|
|
channels \
|
|
|
|
|
channels/misdn \
|
|
|
|
|
funcs \
|
|
|
|
|
main/stdtime \
|
|
|
|
|
apps \
|
|
|
|
|
cdr \
|
|
|
|
|
codecs \
|
|
|
|
|
formats \
|
|
|
|
|
pbx \
|
|
|
|
|
agi \
|
|
|
|
|
res
|
|
|
|
|
|
|
|
|
|
# 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
|
|
|
|
|
# and *.h) to filter out the source-files in the directories. If left
|
|
|
|
|
# blank the following patterns are tested:
|
|
|
|
|
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
|
|
|
|
|
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm
|
|
|
|
|
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
|
|
|
|
|
|
|
|
|
|
FILE_PATTERNS = *.c \
|
|
|
|
|
*.h
|
|
|
|
|
@ -491,17 +515,26 @@ EXCLUDE_SYMLINKS = NO
|
|
|
|
|
|
|
|
|
|
# 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
|
|
|
|
|
# certain files from those directories.
|
|
|
|
|
# certain files from those directories. Note that the wildcards are matched
|
|
|
|
|
# against the file with absolute path, so to exclude all test directories
|
|
|
|
|
# for example use the pattern */test/*
|
|
|
|
|
|
|
|
|
|
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
|
|
|
|
|
# directories that contain example code fragments that are included (see
|
|
|
|
|
# the \include command).
|
|
|
|
|
|
|
|
|
|
EXAMPLE_PATH = ./ \
|
|
|
|
|
doc \
|
|
|
|
|
configs
|
|
|
|
|
doc \
|
|
|
|
|
configs
|
|
|
|
|
|
|
|
|
|
# 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
|
|
|
|
|
@ -582,6 +615,21 @@ REFERENCED_BY_RELATION = YES
|
|
|
|
|
|
|
|
|
|
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
|
|
|
|
|
# will generate a verbatim copy of the header file for each class for
|
|
|
|
|
# which an include is specified. Set to NO to disable this.
|
|
|
|
|
@ -968,7 +1016,7 @@ MACRO_EXPANSION = YES
|
|
|
|
|
|
|
|
|
|
# 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
|
|
|
|
|
# PREDEFINED and EXPAND_AS_PREDEFINED tags.
|
|
|
|
|
# PREDEFINED and EXPAND_AS_DEFINED tags.
|
|
|
|
|
|
|
|
|
|
EXPAND_ONLY_PREDEF = YES
|
|
|
|
|
|
|
|
|
|
@ -1071,6 +1119,14 @@ PERL_PATH = /usr/bin/perl
|
|
|
|
|
|
|
|
|
|
CLASS_DIAGRAMS = NO
|
|
|
|
|
|
|
|
|
|
# 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
|
|
|
|
|
# or is not a class.
|
|
|
|
|
@ -1082,8 +1138,7 @@ HIDE_UNDOC_RELATIONS = YES
|
|
|
|
|
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
|
|
|
|
|
# have no effect if this option is set to NO (the default)
|
|
|
|
|
|
|
|
|
|
#Created by Asterisk Makefile
|
|
|
|
|
#HAVE_DOT = NO
|
|
|
|
|
HAVE_DOT = NO
|
|
|
|
|
|
|
|
|
|
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
|
|
|
|
|
# will generate a graph for each documented class showing the direct and
|
|
|
|
|
@ -1137,6 +1192,14 @@ INCLUDED_BY_GRAPH = YES
|
|
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
@ -1166,33 +1229,13 @@ DOT_PATH =
|
|
|
|
|
|
|
|
|
|
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
|
|
|
|
|
# background. This is disabled by default, which results in a white background.
|
|
|
|
|
|
Russell Bryant
18 years ago