Changeset 992

Show
Ignore:
Timestamp:
09/30/08 23:57:43 (3 months ago)
Author:
takkaria
Message:

Update Doxygen config file; add "make doc" target to autoconf-makefile. (Elly)

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/mk/objective.mk

    r782 r992  
    1313SHOW_CFLAGS ?= $(VERBOSE) 
    1414 
     15DOXYGEN = doxygen 
     16 
    1517LIBDIR = $(libdir) 
    1618BINDIR = $(bindir) 
    …… 
    2022 
    2123default: build 
     24 
     25doc: 
     26        $(DOXYGEN) src/doc/doxygen.conf 
     27 
     28cleandoc: 
     29        $(RM) -rf doc/ 
    2230 
    2331install: build 

  • trunk/src/doc/doxygen.conf

    r918 r992  
    1 # Doxyfile 1.5.1 
     1# Doxyfile 1.5.3 
    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. 
    1927 
    20 PROJECT_NAME           = angband 
     28PROJECT_NAME           = Angband 
    2129 
    2230# The PROJECT_NUMBER tag can be used to enter a project or revision number.  
    …… 
    5462OUTPUT_LANGUAGE        = English 
    5563 
    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 
    65  
    6664# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will  
    6765# include brief member descriptions after the members that are listed in  
    …… 
    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 
    207218# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC  
    208219# tag is set to YES, then doxygen will reuse the documentation of the first  
    …… 
    253264 
    254265EXTRACT_LOCAL_METHODS  = NO 
     266 
     267# If this flag is set to YES, the members of anonymous namespaces will be extracted  
     268# and appear in the documentation as a namespace called 'anonymous_namespace{file}',  
     269# where file will be replaced with the base name of the file that contains the anonymous  
     270# namespace. By default anonymous namespace are hidden. 
     271 
     272EXTRACT_ANON_NSPACES   = NO 
    255273 
    256274# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all  
    …… 
    443461# be obtained via FILE_VERSION_FILTER) 
    444462 
    445 WARN_FORMAT            = "$file:$line: $text" 
     463WARN_FORMAT            = "$file:$line: $text " 
    446464 
    447465# The WARN_LOGFILE tag can be used to specify a file to which warning  
    …… 
    461479 
    462480INPUT                  =  
     481 
     482# This tag can be used to specify the character encoding of the source files that  
     483# doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default  
     484# input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding.  
     485# See http://www.gnu.org/software/libiconv for the list of possible encodings. 
     486 
     487INPUT_ENCODING         = UTF-8 
    463488 
    464489# If the value of the INPUT tag contains directories, you can use the  
    …… 
    469494# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py 
    470495 
    471 FILE_PATTERNS          =  *.h *.c 
     496FILE_PATTERNS          = *.h \ 
     497                         *.c 
    472498 
    473499# The RECURSIVE tag can be used to turn specify whether or not subdirectories  
    …… 
    496522 
    497523EXCLUDE_PATTERNS       =  
     524 
     525# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names  
     526# (namespaces, classes, functions, etc.) that should be excluded from the output.  
     527# The symbol name can be a fully qualified name, a word, or if the wildcard * is used,  
     528# a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test 
     529 
     530EXCLUDE_SYMBOLS        =  
    498531 
    499532# The EXAMPLE_PATH tag can be used to specify one or more files or  
    …… 
    555588# be generated. Documented entities will be cross-referenced with these sources.  
    556589# Note: To get rid of all source code in the generated output, make sure also  
    557 # VERBATIM_HEADERS is set to NO. 
     590# VERBATIM_HEADERS is set to NO. If you have enabled CALL_GRAPH or CALLER_GRAPH  
     591# then you must also enable this option. If you don't then doxygen will produce  
     592# a warning and turn it on anyway 
    558593 
    559594SOURCE_BROWSER         = NO 
    …… 
    680715 
    681716GENERATE_HTMLHELP      = NO 
     717 
     718# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML  
     719# documentation will contain sections that can be hidden and shown after the  
     720# page has loaded. For this to work a browser that supports  
     721# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox  
     722# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). 
     723 
     724HTML_DYNAMIC_SECTIONS  = NO 
    682725 
    683726# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can  
    …… 
    10861129CLASS_DIAGRAMS         = YES 
    10871130 
     1131# You can define message sequence charts within doxygen comments using the \msc  
     1132# command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to  
     1133# produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to  
     1134# specify the directory where the mscgen tool resides. If left empty the tool is assumed to  
     1135# be found in the default search path. 
     1136 
     1137MSCGEN_PATH            =  
     1138 
    10881139# If set to YES, the inheritance and collaboration graphs will hide  
    10891140# inheritance and usage relations if the target is undocumented  
    …… 
    11431194INCLUDED_BY_GRAPH      = YES 
    11441195 
    1145 # If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will  
     1196# If the CALL_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will  
    11461197# generate a call dependency graph for every global function or class method.  
    11471198# Note that enabling this option will significantly increase the time of a run.  
    …… 
    11511202CALL_GRAPH             = YES 
    11521203 
    1153 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then doxygen will  
     1204# If the CALLER_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will  
    11541205# generate a caller dependency graph for every global function or class method.  
    11551206# Note that enabling this option will significantly increase the time of a run.  
    11561207# So in most cases it will be better to enable caller graphs for selected  
    1157 # functions only using the \callergraph command 
     1208# functions only using the \callergraph command. 
    11581209 
    11591210CALLER_GRAPH           = YES 
    …… 
    11881239DOTFILE_DIRS           =  
    11891240 
    1190 # The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width  
    1191 # (in pixels) of the graphs generated by dot. If a graph becomes larger than  
    1192 # this value, doxygen will try to truncate the graph, so that it fits within  
    1193 # the specified constraint. Beware that most browsers cannot cope with very  
    1194 # large images. 
    1195  
    1196 MAX_DOT_GRAPH_WIDTH    = 1024 
    1197  
    1198 # The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height  
    1199 # (in pixels) of the graphs generated by dot. If a graph becomes larger than  
    1200 # this value, doxygen will try to truncate the graph, so that it fits within  
    1201 # the specified constraint. Beware that most browsers cannot cope with very  
    1202 # large images. 
    1203  
    1204 MAX_DOT_GRAPH_HEIGHT   = 1024 
     1241# The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of  
     1242# nodes that will be shown in the graph. If the number of nodes in a graph  
     1243# becomes larger than this value, doxygen will truncate the graph, which is  
     1244# visualized by representing a node as a red box. Note that doxygen if the number  
     1245# of direct children of the root node in a graph is already larger than  
     1246# MAX_DOT_GRAPH_NOTES then the graph will not be shown at all. Also note  
     1247# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. 
     1248 
     1249DOT_GRAPH_MAX_NODES    = 50 
    12051250 
    12061251# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the  
    …… 
    12091254# that lay further from the root node will be omitted. Note that setting this  
    12101255# option to 1 or 2 may greatly reduce the computation time needed for large  
    1211 # code bases. Also note that a graph may be further truncated if the graph's  
    1212 # image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH  
    1213 # and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default),  
    1214 # the graph is not depth-constrained. 
     1256# code bases. Also note that the size of a graph can be further restricted by  
     1257# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. 
    12151258 
    12161259MAX_DOT_GRAPH_DEPTH    = 0