Changeset 1986


Ignore:
Timestamp:
Nov 16, 2007, 8:49:23 PM (13 years ago)
Author:
Sam Hocevar
Message:
  • Updated doxygen file format.
  • Add an empty doxygen.css file.
Location:
libcaca/trunk/doc
Files:
1 added
2 edited

Legend:

Unmodified
Added
Removed

  • libcaca/trunk/doc/Makefile.am

    r1916 r1986  
    11# $Id$
    22
    3 EXTRA_DIST = doxygen.cfg.in footer.html header.html $(man_MANS) $(doxygen_DOX)
     3EXTRA_DIST = doxygen.cfg.in doxygen.css footer.html header.html \
     4             $(man_MANS) $(doxygen_DOX)
    45
    56doxygen_DOX = libcaca.dox user.dox migrating.dox tutorial.dox canvas.dox font.dox style.dox

  • libcaca/trunk/doc/doxygen.cfg.in

    r823 r1986  
    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.
    … …  
    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
    … …  
    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      = NO
     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
    … …  
    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
    … …  
    464488                         @top_srcdir@/cucul \
    465489                         @top_srcdir@/caca
     490
     491# This tag can be used to specify the character encoding of the source files that
     492# doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default
     493# input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding.
     494# See http://www.gnu.org/software/libiconv for the list of possible encodings.
     495
     496INPUT_ENCODING         = UTF-8
    466497
    467498# If the value of the INPUT tag contains directories, you can use the
    … …  
    472503# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
    473504
    474 FILE_PATTERNS          = *.dox *.c cucul.h caca.h \
    475                          NEWS AUTHORS THANKS TODO
     505FILE_PATTERNS          = *.dox \
     506                         *.c \
     507                         cucul.h \
     508                         caca.h \
     509                         NEWS \
     510                         AUTHORS \
     511                         THANKS \
     512                         TODO
    476513
    477514# The RECURSIVE tag can be used to turn specify whether or not subdirectories
    … …  
    501538EXCLUDE_PATTERNS       = *_internal.h \
    502539                         driver_*.c
     540
     541# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
     542# (namespaces, classes, functions, etc.) that should be excluded from the output.
     543# The symbol name can be a fully qualified name, a word, or if the wildcard * is used,
     544# a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test
     545
     546EXCLUDE_SYMBOLS        =
    503547
    504548# The EXAMPLE_PATH tag can be used to specify one or more files or
    … …  
    560604# be generated. Documented entities will be cross-referenced with these sources.
    561605# Note: To get rid of all source code in the generated output, make sure also
    562 # VERBATIM_HEADERS is set to NO.
     606# VERBATIM_HEADERS is set to NO. If you have enabled CALL_GRAPH or CALLER_GRAPH
     607# then you must also enable this option. If you don't then doxygen will produce
     608# a warning and turn it on anyway
    563609
    564610SOURCE_BROWSER         = NO
    … …  
    586632
    587633REFERENCES_RELATION    = YES
     634
     635# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
     636# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
     637# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
     638# link to the source code.  Otherwise they will link to the documentstion.
     639
     640REFERENCES_LINK_SOURCE = YES
    588641
    589642# If the USE_HTAGS tag is set to YES then the references to source code
    … …  
    664717# stylesheet in the HTML output directory as well, or it will be erased!
    665718
    666 HTML_STYLESHEET        =
     719HTML_STYLESHEET        = /dev/null
    667720
    668721# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
    … …  
    678731
    679732GENERATE_HTMLHELP      = NO
     733
     734# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
     735# documentation will contain sections that can be hidden and shown after the
     736# page has loaded. For this to work a browser that supports
     737# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
     738# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
     739
     740HTML_DYNAMIC_SECTIONS  = NO
    680741
    681742# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
    … …  
    10841145CLASS_DIAGRAMS         = YES
    10851146
     1147# You can define message sequence charts within doxygen comments using the \msc
     1148# command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to
     1149# produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to
     1150# specify the directory where the mscgen tool resides. If left empty the tool is assumed to
     1151# be found in the default search path.
     1152
     1153MSCGEN_PATH            =
     1154
    10861155# If set to YES, the inheritance and collaboration graphs will hide
    10871156# inheritance and usage relations if the target is undocumented
    … …  
    11411210INCLUDED_BY_GRAPH      = YES
    11421211
    1143 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
     1212# If the CALL_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will
    11441213# generate a call dependency graph for every global function or class method.
    11451214# Note that enabling this option will significantly increase the time of a run.
    … …  
    11491218CALL_GRAPH             = NO
    11501219
     1220# If the CALLER_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will
     1221# generate a caller dependency graph for every global function or class method.
     1222# Note that enabling this option will significantly increase the time of a run.
     1223# So in most cases it will be better to enable caller graphs for selected
     1224# functions only using the \callergraph command.
     1225
     1226CALLER_GRAPH           = NO
     1227
    11511228# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
    11521229# will graphical hierarchy of all classes instead of a textual one.
    … …  
    11781255DOTFILE_DIRS           = .
    11791256
    1180 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
    1181 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
    1182 # this value, doxygen will try to truncate the graph, so that it fits within
    1183 # the specified constraint. Beware that most browsers cannot cope with very
    1184 # large images.
    1185 
    1186 MAX_DOT_GRAPH_WIDTH    = 1024
    1187 
    1188 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
    1189 # (in pixels) of the graphs generated by dot. If a graph becomes larger than
    1190 # this value, doxygen will try to truncate the graph, so that it fits within
    1191 # the specified constraint. Beware that most browsers cannot cope with very
    1192 # large images.
    1193 
    1194 MAX_DOT_GRAPH_HEIGHT   = 1024
     1257# The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
     1258# nodes that will be shown in the graph. If the number of nodes in a graph
     1259# becomes larger than this value, doxygen will truncate the graph, which is
     1260# visualized by representing a node as a red box. Note that doxygen if the number
     1261# of direct children of the root node in a graph is already larger than
     1262# MAX_DOT_GRAPH_NOTES then the graph will not be shown at all. Also note
     1263# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
     1264
     1265DOT_GRAPH_MAX_NODES    = 50
    11951266
    11961267# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
    … …  
    11991270# that lay further from the root node will be omitted. Note that setting this
    12001271# option to 1 or 2 may greatly reduce the computation time needed for large
    1201 # code bases. Also note that a graph may be further truncated if the graph's
    1202 # image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH
    1203 # and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default),
    1204 # the graph is not depth-constrained.
     1272# code bases. Also note that the size of a graph can be further restricted by
     1273# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
    12051274
    12061275MAX_DOT_GRAPH_DEPTH    = 0
Note: See TracChangeset for help on using the changeset viewer.