www.pudn.com > sipXcallLib.rar > Doxyfile.in, change:2006-02-01,size:23154b


# Doxyfile 1.1.4 
 
# This file describes the settings to be used by doxygen for a project 
# 
# All text after a hash (#) is considered a comment and will be ignored 
# The format is: 
#       TAG = value [value, ...] 
# Values that contain spaces should be placed between quotes (" ") 
 
#--------------------------------------------------------------------------- 
# General configuration options 
#--------------------------------------------------------------------------- 
 
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded  
# by quotes) that should identify the project.  
 
PROJECT_NAME          = @PACKAGE@ 
 
# 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        = "Version @VERSION@" 
 
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)  
# base path where the generated documentation will be put.  
# 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      = . 
 
# The OUTPUT_LANGUAGE tag is used to specify the language in which all  
# 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:  
# Dutch, French, Italian, Czech, Swedish, German, Finnish, Japanese,  
# Spanish and Russian 
 
OUTPUT_LANGUAGE       = English 
 
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at  
# top of each HTML page. The value NO (the default) enables the index and  
# the value YES disables it.  
 
DISABLE_INDEX         = NO 
 
# If the EXTRACT_ALL tag is set to YES all classes and functions will be  
# included in the documentation, even if no documentation was available.  
 
EXTRACT_ALL           = YES 
 
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class  
# will be included in the documentation.  
 
EXTRACT_PRIVATE       = YES 
 
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all  
# undocumented members inside documented classes or files.  
 
HIDE_UNDOC_MEMBERS    = NO 
 
# If the HIDE_UNDOC_CLASSESS tag is set to YES, Doxygen will hide all  
# undocumented classes.  
 
HIDE_UNDOC_CLASSES    = 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).  
# Set to NO to disable this.  
 
BRIEF_MEMBER_DESC     = YES 
 
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend  
# the brief description of a member or function before the detailed description.  
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the  
# brief descriptions will be completely suppressed.  
 
REPEAT_BRIEF          = YES 
 
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then  
# Doxygen will generate a detailed section even if there is only a brief  
# description.  
 
ALWAYS_DETAILED_SEC   = NO 
 
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full  
# path before files name in the file list and in the header files. If set  
# to NO the shortest path that makes the file name unique will be used.  
 
FULL_PATH_NAMES       = NO 
 
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag  
# can be used to strip a user defined part of the path. Stripping is  
# only done if one of the specified strings matches the left-hand part of  
# the path.  
 
STRIP_FROM_PATH       =  
 
# The INTERNAL_DOCS tag determines if documentation  
# that is typed after a \internal command is included. If the tag is set  
# to NO (the default) then the documentation will be excluded.  
# Set it to YES to include the internal documentation.  
 
INTERNAL_DOCS         = NO 
 
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will  
# generate a class diagram (in Html and LaTeX) for classes with base or  
# super classes. Setting the tag to NO turns the diagrams off.  
 
CLASS_DIAGRAMS        = YES 
 
# If the SOURCE_BROWSER tag is set to YES then a list of source files will  
# be generated. Documented entities will be cross-referenced with these sources.  
 
SOURCE_BROWSER        = NO 
 
# Setting the INLINE_SOURCES tag to YES will include the body  
# of functions and classes directly in the documentation.  
 
INLINE_SOURCES        = NO 
 
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct  
# doxygen to hide any special comment blocks from generated source code  
# fragments. Normal C and C++ comments will always remain visible.  
 
STRIP_CODE_COMMENTS   = YES 
 
# If the CASE_SENSE_NAMES tag is set to NO (the default) then Doxygen  
# will only generate file names in lower case letters. If set to  
# YES upper case letters are also allowed. This is useful if you have  
# classes or files whose names only differ in case and if your file system  
# supports case sensitive file names.  
 
CASE_SENSE_NAMES      = 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.  
 
VERBATIM_HEADERS      = YES 
 
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen  
# will put list of the files that are included by a file in the documentation  
# of that file.  
 
SHOW_INCLUDE_FILES    = YES 
 
# If the JAVADOC_AUTOBRIEF tag is set to YES (the default) then Doxygen  
# will interpret the first line (until the first dot) of a JavaDoc-style  
# comment as the brief description. If set to NO, the Javadoc-style will  
# behave just like the Qt-style comments.  
 
JAVADOC_AUTOBRIEF     = YES 
 
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented  
# member inherits the documentation from any documented member that it  
# reimplements.  
 
INHERIT_DOCS          = YES 
 
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]  
# is inserted in the documentation for inline members.  
 
INLINE_INFO           = YES 
 
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen  
# will sort the (detailed) documentation of file and class members  
# alphabetically by member name. If set to NO the members will appear in  
# declaration order.  
 
SORT_MEMBER_DOCS      = YES 
 
# The TAB_SIZE tag can be used to set the number of spaces in a tab.  
# Doxygen uses this value to replace tabs by spaces in code fragments.  
 
TAB_SIZE              = 8 
 
# The ENABLE_SECTIONS tag can be used to enable conditional  
# documentation sections, marked by \if sectionname ... \endif.  
 
ENABLED_SECTIONS      =  
 
#--------------------------------------------------------------------------- 
# configuration options related to warning and progress messages 
#--------------------------------------------------------------------------- 
 
# The QUIET tag can be used to turn on/off the messages that are generated  
# by doxygen. Possible values are YES and NO. If left blank NO is used.  
 
QUIET                 = YES 
 
# The WARNINGS tag can be used to turn on/off the warning messages that are  
# generated by doxygen. Possible values are YES and NO. If left blank  
# NO is used.  
 
WARNINGS              = YES 
 
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings  
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will  
# automatically be disabled.  
 
WARN_IF_UNDOCUMENTED  = YES 
 
# The WARN_FORMAT tag determines the format of the warning messages that  
# doxygen can produce. The string should contain the $file, $line, and $text  
# tags, which will be replaced by the file and line number from which the  
# warning originated and the warning text.  
 
WARN_FORMAT           = "$file:$line: $text" 
 
#--------------------------------------------------------------------------- 
# configuration options related to the input files 
#--------------------------------------------------------------------------- 
 
# The INPUT tag can be used to specify the files and/or directories that contain  
# documented source files. You may enter file names like "myfile.cpp" or  
# directories like "/usr/src/myproject". Separate the files or directories  
# with spaces.  
 
INPUT                 = @top_srcdir@/include @top_srcdir@/src  
 
# 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 all files are included.  
 
FILE_PATTERNS         = *.cpp *.h 
 
# The RECURSIVE tag can be used to turn specify whether or not subdirectories  
# should be searched for input files as well. Possible values are YES and NO.  
# If left blank NO is used.  
 
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               = @top_srcdir@/src/test 
 
# 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.  
 
EXCLUDE_PATTERNS      = config-*.h 
 
# 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          = ../examples 
 
# 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  
# and *.h) to filter out the source-files in the directories. If left  
# blank all files are included.  
 
EXAMPLE_PATTERNS      = *.cpp *.h *.html 
 
# 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  
# the \image command).  
 
IMAGE_PATH            =  
 
# The INPUT_FILTER tag can be used to specify a program that doxygen should  
# invoke to filter for each input file. Doxygen will invoke the filter program  
# by executing (via popen()) the command <filter> <input-file>, where <filter>  
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an  
# input file. Doxygen will then use the output that the filter program writes  
# to standard output.  
 
INPUT_FILTER          =  
 
#--------------------------------------------------------------------------- 
# configuration options related to the alphabetical class index 
#--------------------------------------------------------------------------- 
 
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index  
# of all compounds will be generated. Enable this if the project  
# contains a lot of classes, structs, unions or interfaces.  
 
ALPHABETICAL_INDEX    = YES 
 
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then  
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns  
# in which this list will be split (can be a number in the range [1..20])  
 
COLS_IN_ALPHA_INDEX   = 5 
 
# In case all classes in a project start with a common prefix, all  
# classes will be put under the same header in the alphabetical index.  
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that  
# should be ignored while generating the index headers.  
 
IGNORE_PREFIX         =  
 
#--------------------------------------------------------------------------- 
# configuration options related to the HTML output 
#--------------------------------------------------------------------------- 
 
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will  
# generate HTML output.  
 
GENERATE_HTML         = @enable_html_docs@ 
 
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.  
# 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           = @PACKAGE@ 
 
# The HTML_HEADER tag can be used to specify a personal HTML header for  
# each generated HTML page. If it is left blank doxygen will generate a  
# standard header. 
 
HTML_HEADER           = @srcdir@/header.html 
 
# 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  
# standard footer. 
 
HTML_FOOTER           = @srcdir@/footer.html 
 
# The HTML_STYLESHEET tag can be used to specify a user defined cascading  
# style sheet that is used by each HTML page. It can be used to  
# fine-tune the look of the HTML output. If the tag is left blank doxygen  
# will generate a default style sheet  
 
HTML_STYLESHEET       =  
 
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,  
# files or namespaces will be aligned in HTML using tables. If set to  
# NO a bullet list will be used.  
 
HTML_ALIGN_MEMBERS    = YES 
 
# If the GENERATE_HTMLHELP tag is set to YES, additional index files  
# will be generated that can be used as input for tools like the  
# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)  
# of the generated HTML documentation.  
 
GENERATE_HTMLHELP     = NO 
 
#--------------------------------------------------------------------------- 
# configuration options related to the LaTeX output 
#--------------------------------------------------------------------------- 
 
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will  
# generate Latex output.  
 
GENERATE_LATEX        = @enable_latex_docs@ 
 
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.  
# If a relative path is entered the value of OUTPUT_DIRECTORY will be  
# put in front of it. If left blank `latex' will be used as the default path.  
 
LATEX_OUTPUT          = latex 
 
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact  
# LaTeX documents. This may be useful for small projects and may help to  
# save some trees in general.  
 
COMPACT_LATEX         = NO 
 
# The PAPER_TYPE tag can be used to set the paper type that is used  
# by the printer. Possible values are: a4, a4wide, letter, legal and  
# executive. If left blank a4wide will be used.  
 
PAPER_TYPE            = a4wide 
 
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX  
# packages that should be included in the LaTeX output.  
 
EXTRA_PACKAGES        =  
 
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for  
# the generated latex document. The header should contain everything until  
# the first chapter. If it is left blank doxygen will generate a  
# standard header. Notice: only use this tag if you know what you are doing!  
 
LATEX_HEADER          =  
 
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated  
# is prepared for conversion to pdf (using ps2pdf). The pdf file will  
# contain links (just like the HTML output) instead of page references  
# This makes the output suitable for online browsing using a pdf viewer.  
 
PDF_HYPERLINKS        = NO 
 
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.  
# command to the generated LaTeX files. This will instruct LaTeX to keep  
# running if errors occur, instead of asking the user for help.  
# This option is also used when generating formulas in HTML.  
 
LATEX_BATCHMODE       = NO 
 
#--------------------------------------------------------------------------- 
# configuration options related to the RTF output 
#--------------------------------------------------------------------------- 
 
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output  
# For now this is experimental and is disabled by default. The RTF output  
# is optimised for Word 97 and may not look too pretty with other readers  
# or editors. 
 
GENERATE_RTF          = NO 
 
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.  
# If a relative path is entered the value of OUTPUT_DIRECTORY will be  
# put in front of it. If left blank `rtf' will be used as the default path.  
 
RTF_OUTPUT            = rtf 
 
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact  
# RTF documents. This may be useful for small projects and may help to  
# save some trees in general.  
 
COMPACT_RTF           = NO 
 
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated  
# will contain hyperlink fields. The RTF file will  
# contain links (just like the HTML output) instead of page references.  
# This makes the output suitable for online browsing using a WORD or other.  
# programs which support those fields.  
# Note: wordpad (write) and others do not support links.  
 
RTF_HYPERLINKS        = NO 
 
#--------------------------------------------------------------------------- 
# configuration options related to the man page output 
#--------------------------------------------------------------------------- 
 
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will  
# generate man pages  
 
GENERATE_MAN          = NO 
 
# The MAN_OUTPUT tag is used to specify where the man pages will be put.  
# 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 
 
# The MAN_EXTENSION tag determines the extension that is added to  
# the generated man pages (default is the subroutine's section .3)  
 
MAN_EXTENSION         = .3 
 
#--------------------------------------------------------------------------- 
# Configuration options related to the preprocessor    
#--------------------------------------------------------------------------- 
 
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will  
# evaluate all C-preprocessor directives found in the sources and include  
# files.  
 
ENABLE_PREPROCESSING  = YES 
 
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro  
# names in the source code. If set to NO (the default) only conditional  
# compilation will be performed.  
 
MACRO_EXPANSION       = NO 
 
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files  
# in the INCLUDE_PATH (see below) will be search if a #include is found.  
 
SEARCH_INCLUDES       = YES 
 
# The INCLUDE_PATH tag can be used to specify one or more directories that  
# contain include files that are not input files but should be processed by  
# the preprocessor.  
 
INCLUDE_PATH          = @top_srcdir@/meta/doc 
 
# The PREDEFINED tag can be used to specify one or more macro names that  
# are defined before the preprocessor is started (similar to the -D option of  
# gcc). The argument of the tag is a list of macros of the form: name  
# or name=definition (no spaces). If the definition and the = are  
# omitted =1 is assumed.  
 
PREDEFINED             =  
 
# 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 tag.  
 
EXPAND_ONLY_PREDEF    = YES 
 
#--------------------------------------------------------------------------- 
# Configuration::addtions related to external references    
#--------------------------------------------------------------------------- 
 
# The TAGFILES tag can be used to specify one or more tagfiles.  
 
TAGFILES              = \ 
          @SIPX_DOCDIR@/sipxportlib/sipxportlib.tag=@SIPX_DOCDIR@/sipxportlib/ \ 
          @SIPX_DOCDIR@/sipxtacklib/sipxtacklib.tag=@SIPX_DOCDIR@/sipxtacklib/ \ 
          @SIPX_DOCDIR@/sipxmedialib/sipxmedialib.tag=@SIPX_DOCDIR@/sipxmedialib/ 
 
# When a file name is specified after GENERATE_TAGFILE, doxygen will create  
# a tag file that is based on the input files it reads.  
 
GENERATE_TAGFILE      = @PACKAGE@/@PACKAGE@.tag 
 
# If the ALLEXTERNALS tag is set to YES all external classes will be listed  
# in the class index. If set to NO only the inherited external classes  
# will be listed.  
 
ALLEXTERNALS          = NO 
 
# The PERL_PATH should be the absolute path and name of the perl script  
# interpreter (i.e. the result of `which perl').  
 
PERL_PATH             = /usr/bin/perl 
 
#--------------------------------------------------------------------------- 
# Configuration options related to the dot tool    
#--------------------------------------------------------------------------- 
 
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is  
# available from the path. This tool is part of Graphviz, a graph visualization  
# 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)  
 
HAVE_DOT              = @enable_dot@ 
 
# 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  
# indirect inheritance relations. Setting this tag to YES will force the  
# the CLASS_DIAGRAMS tag to NO. 
 
CLASS_GRAPH           = YES 
 
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen  
# will generate a graph for each documented class showing the direct and  
# indirect implementation dependencies (inheritance, containment, and  
# class references variables) of the class with other documented classes.  
 
COLLABORATION_GRAPH   = YES 
 
# If the ENABLE_PREPROCESSING, INCLUDE_GRAPH, and HAVE_DOT tags are set to  
# YES then doxygen will generate a graph for each documented file showing  
# the direct and indirect include dependencies of the file with other  
# documented files.  
 
INCLUDE_GRAPH         = YES 
 
# 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.  
 
GRAPHICAL_HIERARCHY   = YES 
 
# This tag can be used to specify the path where the dot tool can be found.  
# If left blank, it is assumed the dot tool can be found on the path.  
 
DOT_PATH              =  
 
#--------------------------------------------------------------------------- 
# Configuration::addtions related to the search engine    
#--------------------------------------------------------------------------- 
 
# The SEARCHENGINE tag specifies whether or not a search engine should be  
# used. If set to NO the values of all tags below this one will be ignored.  
 
SEARCHENGINE          = NO 
 
# Got these recommendations from Rich S. 
MULTILINE_CPP_IS_BRIEF = YES 
DETAILS_AT_TOP        = YES 
HIDE_SCOPE_NAMES      = YES 
SHOW_USED_FILES       = NO