From 39b47f73ed563b237ef8daf0afe8ff10cbf3d14c Mon Sep 17 00:00:00 2001 From: Richard Kreckel Date: Thu, 18 Nov 1999 18:27:20 +0000 Subject: [PATCH] - adapted for new and enhanced version of doxygen --- doc/reference/DoxyfileHTML | 128 ++++++++++++++++++++++++++++++++----- doc/reference/DoxyfileTEX | 126 ++++++++++++++++++++++++++++++++---- 2 files changed, 225 insertions(+), 29 deletions(-) diff --git a/doc/reference/DoxyfileHTML b/doc/reference/DoxyfileHTML index f5cf996f..65d561d1 100644 --- a/doc/reference/DoxyfileHTML +++ b/doc/reference/DoxyfileHTML @@ -1,4 +1,5 @@ -# Doxyfile 0.49-990522 +# Doxyfile 0.49-991106 + # 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 @@ -31,7 +32,8 @@ 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 +# The default language is English, other supported languages are: +# Dutch, French, Italian, Czech, Swedish, German and Japanese OUTPUT_LANGUAGE = English @@ -79,13 +81,6 @@ HIDE_UNDOC_CLASSES = NO BRIEF_MEMBER_DESC = YES -# 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 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 @@ -93,7 +88,13 @@ INTERNAL_DOCS = NO REPEAT_BRIEF = YES -# If the FULL_PATH_NAMES tag is set to YES Doxygen will prepend the full +# If the ALWAYS_DETAILS_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. @@ -101,16 +102,30 @@ 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 the specified string matches the left-hand part of the path. +# 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 than the body of a member or +# function will be appended as a block of code to the documentation of. +# that member or function. + +SOURCE_BROWSER = 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 @@ -119,12 +134,35 @@ CLASS_DIAGRAMS = YES CASE_SENSE_NAMES = YES -# If the VERBATIM_HEADERS tag is set the YES (the default) then Doxygen +# 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 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 + +# 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 = 4 + #--------------------------------------------------------------------------- # configuration options related to the input files #--------------------------------------------------------------------------- @@ -167,6 +205,26 @@ EXCLUDE_PATTERNS = EXAMPLE_PATH = +# 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 = + +# 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 = + +# If the value of the IMAGE_PATH tag contains directories, you can use the +# IMAGE_PATTERNS tag to specify one or more wildcard pattern (like *.gif +# and *.eps) to filter out the image files in the directories. If left +# blank all files are included. + +IMAGE_PATTERNS = + # 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 , where @@ -203,12 +261,38 @@ HTML_HEADER = HTML_FOOTER = Doxyfooter +# 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 + +# 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 = NO + +# 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 + #--------------------------------------------------------------------------- # configuration options related to the LaTeX output #--------------------------------------------------------------------------- @@ -222,7 +306,7 @@ GENERATE_LATEX = NO # 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_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 @@ -241,6 +325,20 @@ PAPER_TYPE = a4wide 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 + #--------------------------------------------------------------------------- # configuration options related to the man page output #--------------------------------------------------------------------------- @@ -275,7 +373,7 @@ ENABLE_PREPROCESSING = YES # names in the source code. If set to NO (the default) only conditional # compilation will be performed. -MACRO_EXPANSION = YES +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. @@ -286,7 +384,7 @@ SEARCH_INCLUDES = YES # contain include files that are not input files but should be processed by # the preprocessor. -INCLUDE_PATH = ./ +INCLUDE_PATH = # 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 diff --git a/doc/reference/DoxyfileTEX b/doc/reference/DoxyfileTEX index 2d227b10..30510652 100644 --- a/doc/reference/DoxyfileTEX +++ b/doc/reference/DoxyfileTEX @@ -1,4 +1,5 @@ -# Doxyfile 0.49-990522 +# Doxyfile 0.49-991106 + # 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 @@ -31,7 +32,8 @@ 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 +# The default language is English, other supported languages are: +# Dutch, French, Italian, Czech, Swedish, German and Japanese OUTPUT_LANGUAGE = English @@ -79,13 +81,6 @@ HIDE_UNDOC_CLASSES = NO BRIEF_MEMBER_DESC = YES -# 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 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 @@ -93,7 +88,13 @@ INTERNAL_DOCS = NO REPEAT_BRIEF = YES -# If the FULL_PATH_NAMES tag is set to YES Doxygen will prepend the full +# If the ALWAYS_DETAILS_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. @@ -101,16 +102,30 @@ 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 the specified string matches the left-hand part of the path. +# 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 than the body of a member or +# function will be appended as a block of code to the documentation of. +# that member or function. + +SOURCE_BROWSER = 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 @@ -119,12 +134,35 @@ CLASS_DIAGRAMS = YES CASE_SENSE_NAMES = YES -# If the VERBATIM_HEADERS tag is set the YES (the default) then Doxygen +# 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 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 + +# 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 = 4 + #--------------------------------------------------------------------------- # configuration options related to the input files #--------------------------------------------------------------------------- @@ -167,6 +205,26 @@ EXCLUDE_PATTERNS = EXAMPLE_PATH = +# 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 = + +# 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 = + +# If the value of the IMAGE_PATH tag contains directories, you can use the +# IMAGE_PATTERNS tag to specify one or more wildcard pattern (like *.gif +# and *.eps) to filter out the image files in the directories. If left +# blank all files are included. + +IMAGE_PATTERNS = + # 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 , where @@ -203,12 +261,38 @@ HTML_HEADER = HTML_FOOTER = Doxyfooter +# 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 + +# 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 = NO + +# 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 + #--------------------------------------------------------------------------- # configuration options related to the LaTeX output #--------------------------------------------------------------------------- @@ -241,6 +325,20 @@ PAPER_TYPE = a4wide 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 + #--------------------------------------------------------------------------- # configuration options related to the man page output #--------------------------------------------------------------------------- @@ -275,7 +373,7 @@ ENABLE_PREPROCESSING = YES # names in the source code. If set to NO (the default) only conditional # compilation will be performed. -MACRO_EXPANSION = YES +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. @@ -286,7 +384,7 @@ SEARCH_INCLUDES = YES # contain include files that are not input files but should be processed by # the preprocessor. -INCLUDE_PATH = ./ +INCLUDE_PATH = # 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 -- 2.44.0