diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/commands.doc | 35 | ||||
| -rw-r--r-- | doc/config.doc | 47 | ||||
| -rw-r--r-- | doc/faq.doc | 5 | ||||
| -rw-r--r-- | doc/language.doc | 2 |
4 files changed, 70 insertions, 19 deletions
diff --git a/doc/commands.doc b/doc/commands.doc index 4557bb3..d7ba4f3 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -47,6 +47,7 @@ documentation: \refitem cmdbrief \\brief \refitem cmdbug \\bug \refitem cmdc \\c +\refitem cmdcallgraph \\callgraph \refitem cmdclass \\class \refitem cmdcode \\code \refitem cmdcopydoc \\copydoc @@ -66,6 +67,7 @@ documentation: \refitem cmdendlatexonly \\endlatexonly \refitem cmdendlink \\endlink \refitem cmdendverbatim \\endverbatim +\refitem cmdendxmlonly \\endxmlonly \refitem cmdenum \\enum \refitem cmdexample \\example \refitem cmdexception \\exception @@ -129,6 +131,7 @@ documentation: \refitem cmdversion \\version \refitem cmdwarning \\warning \refitem cmdweakgroup \\weakgroup +\refitem cmdxmlonly \\xmlonly \refitem cmdxrefitem \\xrefitem \refitem cmddollar \\\$ \refitem cmdat \\\@ @@ -181,6 +184,17 @@ doxygen. Unrecognized commands are treated as normal text. \sa page \ref grouping "Grouping", sections \ref cmddefgroup "\\defgroup", \ref cmdingroup "\\ingroup" and \ref cmdweakgroup "\\weakgroup". +\section cmdcallgraph \callgraph + + \addindex \\callgraph + When this command is put in a comment block of a function or method + and \ref cfg_have_dot "HAVE_DOT" is set to YES, then doxygen will + generate a call graph for that function (provided the implementation of the + function or method calls other documented functions). The call graph will + generated regardless of the value of \ref cfg_call_graph "CALL_GRAPH". + \note The completeness (and correctness) of the call graph depends on the + doxygen code parser which is not perfect. + \section cmdclass \class <name> [<header-file>] [<header-name>] \addindex \\class @@ -1552,6 +1566,14 @@ ALIASES = "english=\if english" \ \sa section \ref cmdverbatim "\\verbatim". <hr> +\section cmdendxmlonly \endxmlonly + + \addindex \\endxmlonly + Ends a block of text that was started with a \\xmlonly command. + + \sa section \ref cmdxmlonly "\\xmlonly". + +<hr> \section cmdfdollar \f$ \addindex \\f\$ @@ -1741,6 +1763,19 @@ ALIASES = "english=\if english" \ \\verbatim command or the parser will get confused! <hr> +\section cmdxmlonly \xmlonly + + \addindex \\xmlonly + Starts a block of text that will be verbatim included in the + generated XML output only. The block ends with a + endxmlonly command. + + This command can be used to include custom XML tags. + + \sa section \ref cmdhtmlonly "\\htmlonly" and section + \ref cmdlatexonly "\\latexonly". + +<hr> \section cmdbackslash \\ \addindex \\\\ diff --git a/doc/config.doc b/doc/config.doc index f5d2d50..b86d145 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -62,6 +62,7 @@ followed by the descriptions of the tags grouped by category. \refitem cfg_bin_abspath BIN_ABSPATH \refitem cfg_binary_toc BINARY_TOC \refitem cfg_brief_member_desc BRIEF_MEMBER_DESC +\refitem cfg_call_graph CALL_GRAPH \refitem cfg_case_sense_names CASE_SENSE_NAMES \refitem cfg_cgi_name CGI_NAME \refitem cfg_cgi_url CGI_URL @@ -242,7 +243,8 @@ followed by the descriptions of the tags grouped by category. The default language is English, other supported languages are: Brazilian, Chinese, Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese, Korean, Norwegian, Polish, - Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish and Swedish. + Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, + and Ukrainian. \anchor cfg_use_windows_encoding <dt>\c USE_WINDOWS_ENCODING <dd> @@ -251,8 +253,8 @@ followed by the descriptions of the tags grouped by category. The encoding is not always determined by the language that is chosen, but also whether or not the output is meant for Windows or non-Windows users. In case there is a difference, setting the \c USE_WINDOWS_ENCODING tag to \c YES - forces the Windows enconding, (this is the default for the Windows binary), - whereas setting the tag to \c NO uses a Unix-style encoding (the default for the + forces the Windows encoding, (this is the default for the Windows binary), + whereas setting the tag to \c NO uses a Unix-style encoding (the default for all platforms other than Windows). \anchor cfg_extract_all @@ -366,7 +368,7 @@ function's detailed documentation block. <dt>\c STRIP_FROM_PATH <dd> \addindex STRIP_FROM_PATH If the \c FULL_PATH_NAMES tag is set to \c YES then the \c STRIP_FROM_PATH tag - can be used to strip a user defined part of the path. Stripping is + can be used to strip a user-defined part of the path. Stripping is only done if one of the specified strings matches the left-hand part of the path. @@ -382,8 +384,8 @@ function's detailed documentation block. <dt>\c CASE_SENSE_NAMES <dd> \addindex CASE_SENSE_NAMES If the \c CASE_SENSE_NAMES tag is set to \c NO (the default) then doxygen - will only generate file names in lower case letters. If set to - \c YES upper case letters are also allowed. This is useful if you have + will only generate file names in lower-case letters. If set to + \c YES upper-case letters are also allowed. This is useful if you have classes or files whose names only differ in case and if your file system supports case sensitive file names. @@ -413,7 +415,7 @@ function's detailed documentation block. <dt>\c SHOW_INCLUDE_FILES <dd> \addindex SHOW_INCLUDE_FILES If the SHOW_INCLUDE_FILES tag is set to YES (the default) then doxygen - will put list of the files that are included by a file in the documentation + will put a list of the files that are included by a file in the documentation of that file. \anchor cfg_javadoc_autobrief @@ -529,7 +531,7 @@ function's detailed documentation block. \endverbatim will allow you to put the command \\sideeffect (or \@sideeffect) in the documentation, which - will result in a user defined paragraph with heading "Side Effects:". + will result in a user-defined paragraph with heading "Side Effects:". You can put \\n's in the value part of an alias to insert newlines. \anchor cfg_max_initializer_lines @@ -547,7 +549,7 @@ function's detailed documentation block. \addindex OPTIMIZE_OUTPUT_FOR_C Set the \c OPTIMIZE_OUTPUT_FOR_C tag to \c YES if your project consists of C sources only. Doxygen will then generate output that is more tailored - for C. For instance some of the names that are used will be different. + for C. For instance, some of the names that are used will be different. The list of all members will be omitted, etc. \anchor cfg_optimize_output_java @@ -555,7 +557,7 @@ function's detailed documentation block. \addindex OPTIMIZE_OUTPUT_JAVA Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources only. Doxygen will then generate output that is more tailored for Java. - For instance namespaces will be presented as packages, qualified scopes + For instance, namespaces will be presented as packages, qualified scopes will look different, etc. \anchor cfg_show_used_files @@ -816,7 +818,7 @@ function's detailed documentation block. \anchor cfg_html_header <dt>\c HTML_HEADER <dd> \addindex HTML_HEADER - The \c HTML_HEADER tag can be used to specify a user defined HTML + The \c HTML_HEADER tag can be used to specify a user-defined HTML header file for each generated HTML page. To get valid HTML the header file should contain at least a \c \<HTML\> and a \c \<BODY\> tag, but it is good idea to include the style sheet that is generated by doxygen as well. @@ -847,7 +849,7 @@ function's detailed documentation block. \anchor cfg_html_footer <dt>\c HTML_FOOTER <dd> \addindex HTML_FOOTER - The \c HTML_FOOTER tag can be used to specify a user defined HTML footer for + The \c HTML_FOOTER tag can be used to specify a user-defined HTML footer for each generated HTML page. To get valid HTML the header file should contain at least a \c \</BODY\> and a \c \</HTML\> tag. A minimal example: \verbatim @@ -871,7 +873,7 @@ function's detailed documentation block. \anchor cfg_html_stylesheet <dt>\c HTML_STYLESHEET <dd> \addindex HTML_STYLESHEET - The \c HTML_STYLESHEET tag can be used to specify a user defined cascading + The \c 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. @@ -924,7 +926,7 @@ function's detailed documentation block. If the \c GENERATE_HTMLHELP tag is set to \c YES, the \c HHC_LOCATION tag can be used to specify the location (absolute path including file name) of the HTML help compiler (hhc.exe). If non empty doxygen will try to run - the html help compiler on the generated index.hhp. + the HTML help compiler on the generated index.hhp. \anchor cfg_generate_chi <dt>\c GENERATE_CHI <dd> @@ -1053,7 +1055,7 @@ EXTRA_PACKAGES = times let doxygen write the default header to a separate file. \par Note: - Only use a user defined header if you know what you are doing! + Only use a user-defined header if you know what you are doing! The following commands have a special meaning inside the header: <code>\$title</code>, <code>\$datetime</code>, <code>\$date</code>, @@ -1409,7 +1411,7 @@ TAGFILES = file1=loc1 "file2 = loc2" ... </pre> If the \c CLASS_DIAGRAMS tag is set to \c YES (the default) doxygen will generate a class diagram (in HTML and \f$\mbox{\LaTeX}\f$) for classes with base or super classes. Setting the tag to \c NO turns the diagrams off. - Note that this option is superceded by the HAVE_DOT option below. + Note that this option is superseded by the HAVE_DOT option below. This is only a fallback. It is recommended to install and use dot, since it yield more powerful graphs. @@ -1467,6 +1469,15 @@ TAGFILES = file1=loc1 "file2 = loc2" ... </pre> documented header file showing the documented files that directly or indirectly include this file. +\anchor cfg_call_graph +<dt>\c CALL_GRAPH <dd> + \addindex CALL_GRAPH + If the \c CALL_GRAPH and \c HAVE_DOT tags are set to \c YES then doxygen will + generate a call dependency graph for every global function or class method. + Note that enabling this option will significantly increase the time of a run. + So in most cases it will be better to enable call graphs for selected + functions only using the \\callgraph command. + \anchor cfg_graphical_hierarchy <dt>\c GRAPHICAL_HIERARCHY <dd> \addindex GRAPHICAL_HIERARCHY @@ -1515,7 +1526,7 @@ not sufficient to fit the graph (see \ref cfg_max_dot_graph_width "MAX_DOT_GRAPH_WIDTH" and \ref cfg_max_dot_graph_height "MAX_DOT_GRAPH_HEIGHT"). If 0 is used fot the depth value (the default), the graph is -not depth constraint. +not depth-constraint. \anchor cfg_max_dot_graph_width <dt>\c MAX_DOT_GRAPH_WIDTH <dd> @@ -1537,7 +1548,7 @@ not depth constraint. <dt>\c DOT_CLEANUP <dd> \addindex DOT_CLEANUP If the \c DOT_CLEANUP tag is set to \c YES (the default) doxygen will -remove the intermedate dot files that are used to generate the various graphs. +remove the intermediate dot files that are used to generate the various graphs. </dl> diff --git a/doc/faq.doc b/doc/faq.doc index 5459573..74dc805 100644 --- a/doc/faq.doc +++ b/doc/faq.doc @@ -222,6 +222,11 @@ should send me a code fragment that triggers the message. The workaround the problem put some line-breaks into your file, split it up into smaller parts, or exclude it from the input using EXCLUDE. +<li><b>When running make in the latex dir I get "TeX capacity exceeded". Now what?</b> + +You can edit the texmf.cfg file to increase the default values of the +various buffers and then run "texconfig init". + <li><b>Why are dependencies via STL classes not shown in the dot graphs?</b> Doxygen is unware of the STL classes, so it does not know that class A relates diff --git a/doc/language.doc b/doc/language.doc index bb6cc00..5525e56 100644 --- a/doc/language.doc +++ b/doc/language.doc @@ -25,7 +25,7 @@ Doxygen has built-in support for multiple languages. This means that the text fragments that doxygen generates can be produced in languages other than English (the default) at configuration time. -Currently (version 1.3-20030430), 28 languages +Currently (version 1.3.1), 28 languages are supported (sorted alphabetically): Brazilian Portuguese, Catalan, Chinese, Chinese Traditional, Croatian, Czech, Danish, Dutch, English, Finnish, |