Changeset 1986
- Timestamp:
- 11/16/07 20:49:23 (6 years ago)
- Location:
- libcaca/trunk/doc
- Files:
-
- 1 added
- 2 edited
-
Makefile.am (modified) (1 diff)
-
doxygen.cfg.in (modified) (19 diffs)
-
doxygen.css (added)
Legend:
- Unmodified
- Added
- Removed
-
libcaca/trunk/doc/Makefile.am
r1916 r1986 1 1 # $Id$ 2 2 3 EXTRA_DIST = doxygen.cfg.in footer.html header.html $(man_MANS) $(doxygen_DOX) 3 EXTRA_DIST = doxygen.cfg.in doxygen.css footer.html header.html \ 4 $(man_MANS) $(doxygen_DOX) 4 5 5 6 doxygen_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.61 # Doxyfile 1.5.3-20071008 2 2 3 3 # This file describes the settings to be used by the documentation system … … 15 15 #--------------------------------------------------------------------------- 16 16 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 23 DOXYFILE_ENCODING = UTF-8 24 17 25 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded 18 26 # by quotes) that should identify the project. … … 46 54 # information to generate all constant output in the proper language. 47 55 # 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 # S wedish, 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. 53 61 54 62 OUTPUT_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 YES60 # 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 for62 # all platforms other than Windows).63 64 USE_WINDOWS_ENCODING = NO65 63 66 64 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will … … 136 134 # will interpret the first line (until the first dot) of a JavaDoc-style 137 135 # comment as the brief description. If set to NO, the JavaDoc 138 # comments will behave just like the Qt-style comments (thus requiring an139 # 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.) 140 138 141 139 JAVADOC_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 147 QT_AUTOBRIEF = NO 142 148 143 149 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen … … 205 211 BUILTIN_STL_SUPPORT = NO 206 212 213 # If you use Microsoft's C++/CLI language, you should set this option to YES to 214 # enable parsing support. 215 216 CPP_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 222 SIP_SUPPORT = NO 223 207 224 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 208 225 # tag is set to YES, then doxygen will reuse the documentation of the first … … 253 270 254 271 EXTRACT_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 278 EXTRACT_ANON_NSPACES = NO 255 279 256 280 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all … … 443 467 # be obtained via FILE_VERSION_FILTER) 444 468 445 WARN_FORMAT = "$file:$line: $text "469 WARN_FORMAT = "$file:$line: $text " 446 470 447 471 # The WARN_LOGFILE tag can be used to specify a file to which warning … … 464 488 @top_srcdir@/cucul \ 465 489 @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 496 INPUT_ENCODING = UTF-8 466 497 467 498 # If the value of the INPUT tag contains directories, you can use the … … 472 503 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py 473 504 474 FILE_PATTERNS = *.dox *.c cucul.h caca.h \ 475 NEWS AUTHORS THANKS TODO 505 FILE_PATTERNS = *.dox \ 506 *.c \ 507 cucul.h \ 508 caca.h \ 509 NEWS \ 510 AUTHORS \ 511 THANKS \ 512 TODO 476 513 477 514 # The RECURSIVE tag can be used to turn specify whether or not subdirectories … … 501 538 EXCLUDE_PATTERNS = *_internal.h \ 502 539 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 546 EXCLUDE_SYMBOLS = 503 547 504 548 # The EXAMPLE_PATH tag can be used to specify one or more files or … … 560 604 # be generated. Documented entities will be cross-referenced with these sources. 561 605 # 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 563 609 564 610 SOURCE_BROWSER = NO … … 586 632 587 633 REFERENCES_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 640 REFERENCES_LINK_SOURCE = YES 588 641 589 642 # If the USE_HTAGS tag is set to YES then the references to source code … … 664 717 # stylesheet in the HTML output directory as well, or it will be erased! 665 718 666 HTML_STYLESHEET = 719 HTML_STYLESHEET = /dev/null 667 720 668 721 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, … … 678 731 679 732 GENERATE_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 740 HTML_DYNAMIC_SECTIONS = NO 680 741 681 742 # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can … … 1084 1145 CLASS_DIAGRAMS = YES 1085 1146 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 1153 MSCGEN_PATH = 1154 1086 1155 # If set to YES, the inheritance and collaboration graphs will hide 1087 1156 # inheritance and usage relations if the target is undocumented … … 1141 1210 INCLUDED_BY_GRAPH = YES 1142 1211 1143 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will1212 # If the CALL_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will 1144 1213 # generate a call dependency graph for every global function or class method. 1145 1214 # Note that enabling this option will significantly increase the time of a run. … … 1149 1218 CALL_GRAPH = NO 1150 1219 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 1226 CALLER_GRAPH = NO 1227 1151 1228 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 1152 1229 # will graphical hierarchy of all classes instead of a textual one. … … 1178 1255 DOTFILE_DIRS = . 1179 1256 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 1265 DOT_GRAPH_MAX_NODES = 50 1195 1266 1196 1267 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the … … 1199 1270 # that lay further from the root node will be omitted. Note that setting this 1200 1271 # 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. 1205 1274 1206 1275 MAX_DOT_GRAPH_DEPTH = 0
Note: See TracChangeset
for help on using the changeset viewer.
