Changeset fed9433 for doc/devel.cfg


Ignore:
Timestamp:
Apr 30, 2008, 9:39:31 PM (16 years ago)
Author:
Paul Brossier <piem@piem.org>
Branches:
feature/autosink, feature/cnn, feature/cnn_org, feature/constantq, feature/crepe, feature/crepe_org, feature/pitchshift, feature/pydocstrings, feature/timestretch, fix/ffmpeg5, master, pitchshift, sampler, timestretch, yinfft+
Children:
98cc475
Parents:
679441e
Message:

doc/{user,devel}.cfg: update config to new doxygen, adapt to multiple directories

File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/devel.cfg

    r679441e rfed9433  
    1 # Doxyfile 1.4.6
     1# Doxyfile 1.5.3-20071008
    22
    33# This file describes the settings to be used by the documentation system
     
    1515#---------------------------------------------------------------------------
    1616
     17# This tag specifies the encoding used for all characters in the config file that
     18# follow. The default is UTF-8 which is also the encoding used for all text before
     19# the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into
     20# libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of
     21# possible encodings.
     22
     23DOXYFILE_ENCODING      = UTF-8
     24
    1725# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
    1826# by quotes) that should identify the project.
     
    2432# if some version control system is used.
    2533
    26 #PROJECT_NUMBER         = 0.3.0
     34PROJECT_NUMBER         =
    2735
    2836# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
     
    4654# information to generate all constant output in the proper language.
    4755# The default language is English, other supported languages are:
    48 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish,
    49 # Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese,
    50 # Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian,
    51 # Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish,
    52 # Swedish, and Ukrainian.
     56# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
     57# Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian,
     58# Italian, Japanese, Japanese-en (Japanese with English messages), Korean,
     59# Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian,
     60# Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
    5361
    5462OUTPUT_LANGUAGE        = English
    55 
    56 # This tag can be used to specify the encoding used in the generated output.
    57 # The encoding is not always determined by the language that is chosen,
    58 # but also whether or not the output is meant for Windows or non-Windows users.
    59 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
    60 # forces the Windows encoding (this is the default for the Windows binary),
    61 # whereas setting the tag to NO uses a Unix-style encoding (the default for
    62 # all platforms other than Windows).
    63 
    64 USE_WINDOWS_ENCODING   = NO
    6563
    6664# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
     
    107105# to NO the shortest path that makes the file name unique will be used.
    108106
    109 FULL_PATH_NAMES        = NO
     107FULL_PATH_NAMES        = YES
    110108
    111109# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
     
    116114# path to strip.
    117115
    118 STRIP_FROM_PATH        =
     116STRIP_FROM_PATH        = ..
    119117
    120118# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
     
    136134# will interpret the first line (until the first dot) of a JavaDoc-style
    137135# comment as the brief description. If set to NO, the JavaDoc
    138 # comments will behave just like the Qt-style comments (thus requiring an
    139 # explicit @brief command for a brief description.
     136# comments will behave just like regular Qt-style comments
     137# (thus requiring an explicit @brief command for a brief description.)
    140138
    141139JAVADOC_AUTOBRIEF      = YES
     140
     141# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
     142# interpret the first line (until the first dot) of a Qt-style
     143# comment as the brief description. If set to NO, the comments
     144# will behave just like regular Qt-style comments (thus requiring
     145# an explicit \brief command for a brief description.)
     146
     147QT_AUTOBRIEF           = NO
    142148
    143149# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
     
    205211BUILTIN_STL_SUPPORT    = NO
    206212
     213# If you use Microsoft's C++/CLI language, you should set this option to YES to
     214# enable parsing support.
     215
     216CPP_CLI_SUPPORT        = NO
     217
     218# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
     219# Doxygen will parse them like normal C++ but will assume all classes use public
     220# instead of private inheritance when no explicit protection keyword is present.
     221
     222SIP_SUPPORT            = NO
     223
    207224# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
    208225# tag is set to YES, then doxygen will reuse the documentation of the first
     
    253270
    254271EXTRACT_LOCAL_METHODS  = NO
     272
     273# If this flag is set to YES, the members of anonymous namespaces will be extracted
     274# and appear in the documentation as a namespace called 'anonymous_namespace{file}',
     275# where file will be replaced with the base name of the file that contains the anonymous
     276# namespace. By default anonymous namespace are hidden.
     277
     278EXTRACT_ANON_NSPACES   = NO
    255279
    256280# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
     
    388412# in the documentation. The default is NO.
    389413
    390 SHOW_DIRECTORIES       = NO
     414SHOW_DIRECTORIES       = YES
    391415
    392416# The FILE_VERSION_FILTER tag can be used to specify a program or script that
     
    443467# be obtained via FILE_VERSION_FILTER)
    444468
    445 WARN_FORMAT            = "$file:$line: $text"
     469WARN_FORMAT            = "$file:$line: $text "
    446470
    447471# The WARN_LOGFILE tag can be used to specify a file to which warning
     
    460484# with spaces.
    461485
    462 INPUT                  = ../src \
    463                          ../ext
     486INPUT                  = ../src ../ext
     487
     488# This tag can be used to specify the character encoding of the source files that
     489# doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default
     490# input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding.
     491# See http://www.gnu.org/software/libiconv for the list of possible encodings.
     492
     493INPUT_ENCODING         = UTF-8
    464494
    465495# If the value of the INPUT tag contains directories, you can use the
     
    476506# If left blank NO is used.
    477507
    478 RECURSIVE              = NO
     508RECURSIVE              = YES
    479509
    480510# The EXCLUDE tag can be used to specify files and/or directories that should
     
    498528EXCLUDE_PATTERNS       =
    499529
     530# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
     531# (namespaces, classes, functions, etc.) that should be excluded from the output.
     532# The symbol name can be a fully qualified name, a word, or if the wildcard * is used,
     533# a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test
     534
     535EXCLUDE_SYMBOLS        =
     536
    500537# The EXAMPLE_PATH tag can be used to specify one or more files or
    501538# directories that contain example code fragments that are included (see
    502539# the \include command).
    503540
    504 EXAMPLE_PATH           = ../examples ../
     541EXAMPLE_PATH           = ../examples \
     542                         ../
    505543
    506544# If the value of the EXAMPLE_PATH tag contains directories, you can use the
     
    556594# be generated. Documented entities will be cross-referenced with these sources.
    557595# Note: To get rid of all source code in the generated output, make sure also
    558 # VERBATIM_HEADERS is set to NO.
     596# VERBATIM_HEADERS is set to NO. If you have enabled CALL_GRAPH or CALLER_GRAPH
     597# then you must also enable this option. If you don't then doxygen will produce
     598# a warning and turn it on anyway
    559599
    560600SOURCE_BROWSER         = YES
     
    582622
    583623REFERENCES_RELATION    = YES
     624
     625# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
     626# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
     627# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
     628# link to the source code.  Otherwise they will link to the documentstion.
     629
     630REFERENCES_LINK_SOURCE = YES
    584631
    585632# If the USE_HTAGS tag is set to YES then the references to source code
     
    675722GENERATE_HTMLHELP      = NO
    676723
     724# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
     725# documentation will contain sections that can be hidden and shown after the
     726# page has loaded. For this to work a browser that supports
     727# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
     728# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
     729
     730HTML_DYNAMIC_SECTIONS  = NO
     731
    677732# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
    678733# be used to specify the file name of the resulting .chm file. You
     
    739794# generate Latex output.
    740795
    741 GENERATE_LATEX         = YES
     796GENERATE_LATEX         = NO
    742797
    743798# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
     
    10801135CLASS_DIAGRAMS         = YES
    10811136
     1137# You can define message sequence charts within doxygen comments using the \msc
     1138# command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to
     1139# produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to
     1140# specify the directory where the mscgen tool resides. If left empty the tool is assumed to
     1141# be found in the default search path.
     1142
     1143MSCGEN_PATH            =
     1144
    10821145# If set to YES, the inheritance and collaboration graphs will hide
    10831146# inheritance and usage relations if the target is undocumented
     
    11371200INCLUDED_BY_GRAPH      = YES
    11381201
    1139 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
     1202# If the CALL_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will
    11401203# generate a call dependency graph for every global function or class method.
    11411204# Note that enabling this option will significantly increase the time of a run.
     
    11451208CALL_GRAPH             = NO
    11461209
     1210# If the CALLER_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will
     1211# generate a caller dependency graph for every global function or class method.
     1212# Note that enabling this option will significantly increase the time of a run.
     1213# So in most cases it will be better to enable caller graphs for selected
     1214# functions only using the \callergraph command.
     1215
     1216CALLER_GRAPH           = NO
     1217
    11471218# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
    11481219# will graphical hierarchy of all classes instead of a textual one.
     
    11741245DOTFILE_DIRS           =
    11751246
    1176 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
    1177 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
    1178 # this value, doxygen will try to truncate the graph, so that it fits within
    1179 # the specified constraint. Beware that most browsers cannot cope with very
    1180 # large images.
    1181 
    1182 MAX_DOT_GRAPH_WIDTH    = 1024
    1183 
    1184 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
    1185 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
    1186 # this value, doxygen will try to truncate the graph, so that it fits within
    1187 # the specified constraint. Beware that most browsers cannot cope with very
    1188 # large images.
    1189 
    1190 MAX_DOT_GRAPH_HEIGHT   = 1024
     1247# The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
     1248# nodes that will be shown in the graph. If the number of nodes in a graph
     1249# becomes larger than this value, doxygen will truncate the graph, which is
     1250# visualized by representing a node as a red box. Note that doxygen if the number
     1251# of direct children of the root node in a graph is already larger than
     1252# MAX_DOT_GRAPH_NOTES then the graph will not be shown at all. Also note
     1253# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
     1254
     1255DOT_GRAPH_MAX_NODES    = 50
    11911256
    11921257# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
     
    11951260# that lay further from the root node will be omitted. Note that setting this
    11961261# option to 1 or 2 may greatly reduce the computation time needed for large
    1197 # code bases. Also note that a graph may be further truncated if the graph's
    1198 # image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH
    1199 # and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default),
    1200 # the graph is not depth-constrained.
     1262# code bases. Also note that the size of a graph can be further restricted by
     1263# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
    12011264
    12021265MAX_DOT_GRAPH_DEPTH    = 0
Note: See TracChangeset for help on using the changeset viewer.