From 79099187058387c3d77bc33f46f02ee2315ef83d Mon Sep 17 00:00:00 2001 From: Dimitri van Heesch Date: Sun, 19 May 2013 12:23:25 +0000 Subject: Release-1.8.4 --- INSTALL | 4 +- README | 4 +- configure | 6 +- doc/changelog.doc | 157 ++++++++++- doc/commands.doc | 518 +++++++++++++++++++++--------------- doc/config.doc | 497 ++++++++++++++++++----------------- doc/faq.doc | 2 +- doc/htmlcmds.doc | 4 +- doc/install.doc | 96 +------ doc/language.doc | 8 +- doc/searching.doc | 2 +- doc/starting.doc | 15 +- doc/translator_report.txt | 68 +---- doc/trouble.doc | 2 +- doc/xmlcmds.doc | 2 +- src/clangparser.cpp | 68 +++-- src/commentscan.l | 7 +- src/config.l | 5 +- src/config.xml | 29 +-- src/configoptions.cpp | 24 +- src/docparser.cpp | 4 - src/doctokenizer.l | 59 +++-- src/doxygen.cpp | 3 +- src/doxygen.sty | 464 +++++++++++++++++++++++++++++++++ src/doxygen_sty.h | 464 +++++++++++++++++++++++++++++++++ src/latexgen.cpp | 469 +-------------------------------- src/libdoxygen.pro.in | 1 + src/libdoxygen.t.in | 3 + src/markdown.cpp | 9 +- src/pagedef.cpp | 17 +- src/pre.l | 2 + src/scanner.l | 11 +- src/translator_ar.h | 2 +- src/translator_ro.h | 649 ++++++++++++++++++++++++++++++++-------------- src/translator_sk.h | 59 ++++- 35 files changed, 2371 insertions(+), 1363 deletions(-) create mode 100644 src/doxygen.sty create mode 100644 src/doxygen_sty.h diff --git a/INSTALL b/INSTALL index 02f3338..eced15a 100644 --- a/INSTALL +++ b/INSTALL @@ -1,7 +1,7 @@ -DOXYGEN Version 1.8.3.1-20130512 +DOXYGEN Version 1.8.4 Please read the installation section of the manual (http://www.doxygen.org/install.html) for instructions. -------- -Dimitri van Heesch (12 May 2013) +Dimitri van Heesch (19 May 2013) diff --git a/README b/README index a002402..2ecb0a5 100644 --- a/README +++ b/README @@ -1,4 +1,4 @@ -DOXYGEN Version 1.8.3.1_20130512 +DOXYGEN Version 1.8.4 Please read INSTALL for compilation instructions. @@ -26,4 +26,4 @@ forum. Enjoy, -Dimitri van Heesch (dimitri@stack.nl) (12 May 2013) +Dimitri van Heesch (dimitri@stack.nl) (19 May 2013) diff --git a/configure b/configure index db6ccdc..ba1bca2 100755 --- a/configure +++ b/configure @@ -17,10 +17,10 @@ doxygen_version_major=1 doxygen_version_minor=8 -doxygen_version_revision=3.1 +doxygen_version_revision=4 #NOTE: Setting version_mmn to "NO" will omit mmn info from the package. -doxygen_version_mmn=20130512 +doxygen_version_mmn=NO bin_dirs=`echo $PATH | sed -e "s/:/ /g"` @@ -478,7 +478,7 @@ if test "$f_libclang" = YES; then if test "$f_libclangstatic" = NO; then libclang_link="-L $i -lclang" else - libclang_link="$i/libLLVMBitReader.a $i/libLLVMMC.a $i/libLLVMMCParser.a $i/libLLVMSupport.a $i/libclang.a $i/libclangAST.a $i/libclangAnalysis.a $i/libclangBasic.a $i/libclangDriver.a $i/libclangEdit.a $i/libclangFrontend.a $i/libclangLex.a $i/libclangParse.a $i/libclangRewriteCore.a $i/libclangSema.a $i/libclangSerialization.a $i/libclangStaticAnalyzerCore.a" + libclang_link="$i/libclang.a $i/libclangFrontend.a $i/libclangSerialization.a $i/libclangParse.a $i/libclangSema.a $i/libclangAnalysis.a $i/libclangStaticAnalyzerCore.a $i/libclangAST.a $i/libclangBasic.a $i/libclangDriver.a $i/libclangEdit.a $i/libclangLex.a $i/libclangRewriteCore.a $i/libLLVMBitReader.a $i/libLLVMMC.a $i/libLLVMMCParser.a $i/libLLVMSupport.a -ldl -lpthread" fi break fi diff --git a/doc/changelog.doc b/doc/changelog.doc index f43bdff..04bb8b4 100644 --- a/doc/changelog.doc +++ b/doc/changelog.doc @@ -1,6 +1,161 @@ /** \page changelog Changelog \tableofcontents \section log_1_8 Release 1.8 + +\subsection log_1_8_4 Release 1.8.4 +\htmlonly +(release date 19-05-2013) + +

Changes

+ +

New features

+ +

Bug fixes (ids refer to the bugzilla database)

+ +\endhtmlonly + \subsection log_1_8_3_1 Release 1.8.3.1 \htmlonly (release date 20-01-2013) @@ -27,7 +182,7 @@
  • To make navindex section without any link inside a layout file you can use usergroup with special title [none]. -

    Bug fixes (ids refer to the bugzilla database)

    +

    Bug fixes

    - If left blank a4 will be used. + If left blank \c a4 will be used. \anchor cfg_extra_packages
    \c EXTRA_PACKAGES
    @@ -2112,22 +2132,25 @@ EXTRA_PACKAGES = times \$projectnumber. Doxygen will replace them by respectively the title of the page, the current date and time, only the current date, - the version number of doxygen, the project name (see \c PROJECT_NAME), or the - project number (see \c PROJECT_NUMBER). + the version number of doxygen, the project name (see \ref cfg_project_name "PROJECT_NAME"), or the + project number (see \ref cfg_project_number "PROJECT_NUMBER"). \anchor cfg_latex_footer
    \c LATEX_FOOTER
    \addindex LATEX_FOOTER - The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for - the generated latex document. The footer should contain everything after + The LATEX_FOOTER tag can be used to specify a personal \f$\mbox{\LaTeX}\f$ footer for + the generated \f$\mbox{\LaTeX}\f$ document. The footer should contain everything after the last chapter. If it is left blank doxygen will generate a - standard footer. Notice: only use this tag if you know what you are doing! + standard footer. + + \par Note: + Only use a user-defined footer if you know what you are doing! \anchor cfg_latex_extra_files
    \c LATEX_EXTRA_FILES
    \addindex LATEX_EXTRA_FILES The \c LATEX_EXTRA_FILES tag can be used to specify one or more extra images - or other source files which should be copied to the LaTeX output directory. + or other source files which should be copied to the \f$\mbox{\LaTeX}\f$ output directory. Note that the files will be copied as-is; there are no commands or markers available. @@ -2136,7 +2159,7 @@ EXTRA_PACKAGES = times \addindex PDF_HYPERLINKS If the \c PDF_HYPERLINKS tag is set to \c YES, the \f$\mbox{\LaTeX}\f$ that - is generated is prepared for conversion to PDF (using ps2pdf or pdflatex). + is generated is prepared for conversion to PDF (using \c ps2pdf or \c pdflatex). The PDF file will contain links (just like the HTML output) instead of page references. This makes the output suitable for online browsing using a PDF viewer. @@ -2146,14 +2169,14 @@ EXTRA_PACKAGES = times \addindex LATEX_PDFLATEX If the \c LATEX_PDFLATEX tag is set to \c YES, doxygen will use - pdflatex to generate the PDF file directly from the \f$\mbox{\LaTeX}\f$ + \c pdflatex to generate the PDF file directly from the \f$\mbox{\LaTeX}\f$ files. \anchor cfg_latex_batchmode
    \c LATEX_BATCHMODE
    \addindex LATEX_BATCHMODE - If the \c LATEX_BATCHMODE tag is set to \c YES, doxygen will add the \\batchmode. + If the \c LATEX_BATCHMODE tag is set to \c YES, doxygen will add the \c \\batchmode command to the generated \f$\mbox{\LaTeX}\f$ files. This will instruct \f$\mbox{\LaTeX}\f$ to keep running if errors occur, instead of asking the user for help. This option is also used when generating formulas @@ -2179,7 +2202,7 @@ EXTRA_PACKAGES = times \anchor cfg_latex_source_code
    \c LATEX_SOURCE_CODE
    If \c LATEX_SOURCE_CODE is set to \c YES then doxygen will include - source code with syntax highlighting in the LaTeX output. + source code with syntax highlighting in the \f$\mbox{\LaTeX}\f$ output. Note that which sources are shown also depends on other settings such as \ref cfg_source_browser "SOURCE_BROWSER". @@ -2198,8 +2221,8 @@ EXTRA_PACKAGES = times
    \c RTF_OUTPUT
    \addindex RTF_OUTPUT The \c RTF_OUTPUT tag is used to specify where the RTF docs will be put. - If a relative path is entered the value of \c OUTPUT_DIRECTORY will be - put in front of it. If left blank \c rtf will be used as the default path. + If a relative path is entered the value of \ref cfg_output_directory "OUTPUT_DIRECTORY" will be + put in front of it. If left blank '`rtf`' will be used as the default path. \anchor cfg_compact_rtf
    \c COMPACT_RTF
    @@ -2252,9 +2275,9 @@ EXTRA_PACKAGES = times
    \c MAN_OUTPUT
    \addindex MAN_OUTPUT The \c MAN_OUTPUT tag is used to specify where the man pages will be put. - If a relative path is entered the value of \c OUTPUT_DIRECTORY will be - put in front of it. If left blank 'man' will be used as the default path. - A directory man3 will be created inside the directory specified by + If a relative path is entered the value of \ref cfg_output_directory "OUTPUT_DIRECTORY" will be + put in front of it. If left blank '`man`' will be used as the default path. + A directory \c man3 will be created inside the directory specified by \c MAN_OUTPUT. \anchor cfg_man_extension @@ -2263,7 +2286,7 @@ EXTRA_PACKAGES = times The \c MAN_EXTENSION tag determines the extension that is added to the generated man pages (default is the subroutine's section .3). In case the manual section does not start with a number, the number 3 is prepended. - The dot (.) at the beginning of the MAN_EXTENSION is optional. + The dot (.) at the beginning of the \c MAN_EXTENSION is optional. \anchor cfg_man_links
    \c MAN_LINKS
    @@ -2282,7 +2305,7 @@ EXTRA_PACKAGES = times
    \c GENERATE_XML
    \addindex GENERATE_XML - If the \c GENERATE_XML tag is set to \c YES Doxygen will + If the \c GENERATE_XML tag is set to \c YES doxygen will generate an XML file that captures the structure of the code including all documentation. @@ -2290,27 +2313,27 @@ EXTRA_PACKAGES = times
    \c XML_OUTPUT
    \addindex XML_OUTPUT The \c XML_OUTPUT tag is used to specify where the XML pages will be put. - If a relative path is entered the value of \c OUTPUT_DIRECTORY will be - put in front of it. If left blank \c xml will be used as the default path. + If a relative path is entered the value of \ref cfg_output_directory "OUTPUT_DIRECTORY" will be + put in front of it. If left blank '`xml`' will be used as the default path. \anchor cfg_xml_schema
    \c XML_SCHEMA
    \addindex XML_SCHEMA - The \c XML_SCHEMA tag can be used to specify an XML schema, + The \c XML_SCHEMA tag can be used to specify a XML schema, which can be used by a validating XML parser to check the syntax of the XML files. \anchor cfg_xml_dtd
    \c XML_DTD
    \addindex XML_DTD - The \c XML_DTD tag can be used to specify an XML DTD, + The \c XML_DTD tag can be used to specify a XML DTD, which can be used by a validating XML parser to check the syntax of the XML files. \anchor cfg_xml_programlisting
    \c XML_PROGRAMLISTING
    \addindex XML_PROGRAMLISTING - If the \c XML_PROGRAMLISTING tag is set to \c YES Doxygen will + If the \c XML_PROGRAMLISTING tag is set to \c YES doxygen will dump the program listings (including syntax highlighting and cross-referencing information) to the XML output. Note that enabling this will significantly increase the size of the XML output. @@ -2323,7 +2346,7 @@ EXTRA_PACKAGES = times
    \c GENERATE_DOCBOOK
    \addindex GENERATE_DOCBOOK -If the \c GENERATE_DOCBOOK tag is set to \c YES Doxygen will generate Docbook files +If the \c GENERATE_DOCBOOK tag is set to \c YES doxygen will generate Docbook files that can be used to generate PDF. \anchor cfg_docbook_output @@ -2331,7 +2354,7 @@ that can be used to generate PDF. \addindex DOCBOOK_OUTPUT The \c DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put. If a relative path is entered the value of \ref cfg_output_directory "OUTPUT_DIRECTORY" will be put in -front of it. If left blank docbook will be used as the default path. +front of it. If left blank '`docbook`' will be used as the default path. @@ -2341,7 +2364,7 @@ front of it. If left blank docbook will be used as the default path.
    \c GENERATE_AUTOGEN_DEF
    \addindex GENERATE_AUTOGEN_DEF - If the \c GENERATE_AUTOGEN_DEF tag is set to \c YES Doxygen will + If the \c GENERATE_AUTOGEN_DEF tag is set to \c YES doxygen will generate an AutoGen Definitions (see http://autogen.sf.net) file that captures the structure of the code including all documentation. Note that this feature is still experimental @@ -2355,7 +2378,7 @@ front of it. If left blank docbook will be used as the default path.
    \c GENERATE_PERLMOD
    \addindex GENERATE_PERLMOD - If the \c GENERATE_PERLMOD tag is set to \c YES Doxygen will + If the \c GENERATE_PERLMOD tag is set to \c YES doxygen will generate a Perl module file that captures the structure of the code including all documentation. Note that this feature is still experimental and incomplete at the @@ -2364,8 +2387,8 @@ front of it. If left blank docbook will be used as the default path. \anchor cfg_perlmod_latex
    \c PERLMOD_LATEX
    \addindex PERLMOD_LATEX - If the \c PERLMOD_LATEX tag is set to \c YES Doxygen will generate - the necessary Makefile rules, Perl scripts and LaTeX code to be able + If the \c PERLMOD_LATEX tag is set to \c YES doxygen will generate + the necessary Makefile rules, Perl scripts and \f$\mbox{\LaTeX}\f$ code to be able to generate PDF and DVI output from the Perl module output. \anchor cfg_perlmod_pretty @@ -2380,10 +2403,10 @@ front of it. If left blank docbook will be used as the default path. \anchor cfg_perlmod_makevar_prefix
    \c PERLMOD_MAKEVAR_PREFIX
    \addindex PERLMOD_MAKEVAR_PREFIX - The names of the make variables in the generated doxyrules.make file + The names of the make variables in the generated `doxyrules.make` file are prefixed with the string contained in \c PERLMOD_MAKEVAR_PREFIX. - This is useful so different doxyrules.make files included by the same - Makefile don't overwrite each other's variables. + This is useful so different `doxyrules.make` files included by the same + `Makefile` don't overwrite each other's variables. @@ -2403,20 +2426,20 @@ front of it. If left blank docbook will be used as the default path. If the \c MACRO_EXPANSION tag is set to \c YES doxygen will expand all macro names in the source code. If set to \c NO (the default) only conditional compilation will be performed. Macro expansion can be done in a controlled - way by setting \c EXPAND_ONLY_PREDEF to \c YES. + way by setting \ref cfg_expand_only_predef "EXPAND_ONLY_PREDEF" to \c YES. \anchor cfg_expand_only_predef
    \c EXPAND_ONLY_PREDEF
    \addindex EXPAND_ONLY_PREDEF - If the \c EXPAND_ONLY_PREDEF and \c MACRO_EXPANSION tags are both set to \c YES + If the \c EXPAND_ONLY_PREDEF and \ref cfg_macro_expansion "MACRO_EXPANSION" tags are both set to \c YES then the macro expansion is limited to the macros specified with the - \c PREDEFINED and \c EXPAND_AS_DEFINED tags. + \ref cfg_predefined "PREDEFINED" and \ref cfg_expand_as_defined "EXPAND_AS_DEFINED" tags. \anchor cfg_search_includes
    \c SEARCH_INCLUDES
    \addindex SEARCH_INCLUDES If the \c SEARCH_INCLUDES tag is set to \c YES (the default) the includes files - in the \c INCLUDE_PATH (see below) will be searched if a \#include is found. + in the \ref cfg_include_path "INCLUDE_PATH" will be searched if a \c \#include is found. \anchor cfg_include_path
    \c INCLUDE_PATH
    @@ -2430,27 +2453,28 @@ front of it. If left blank docbook will be used as the default path. \addindex INCLUDE_FILE_PATTERNS You can use the \c INCLUDE_FILE_PATTERNS tag to specify one or more wildcard patterns (like `*.h` and `*.hpp`) to filter out the header-files in the - directories. If left blank, the patterns specified with \c FILE_PATTERNS will + directories. If left blank, the patterns specified with \ref cfg_file_patterns "FILE_PATTERNS" will be used. \anchor cfg_predefined
    \c PREDEFINED
    \addindex PREDEFINED The \c PREDEFINED tag can be used to specify one or more macro names that - are defined before the preprocessor is started (similar to the -D option of - gcc). The argument of the tag is a list of macros of the form: + are defined before the preprocessor is started (similar to the `-D` option of + \c gcc). The argument of the tag is a list of macros of the form: name or name=definition (no spaces). If the definition and the "=" are omitted, "=1" is assumed. To prevent - a macro definition from being undefined via \#undef or recursively expanded - use the := operator instead of the = operator. + a macro definition from being undefined via \c \#undef or recursively expanded + use the \c := operator instead of the \c = operator. \anchor cfg_expand_as_defined
    \c EXPAND_AS_DEFINED
    \addindex EXPAND_AS_DEFINED - If the \c MACRO_EXPANSION and \c EXPAND_ONLY_PREDEF tags are set to \c YES then + If the \ref cfg_macro_expansion "MACRO_EXPANSION" and + \ref cfg_expand_only_predef "EXPAND_ONLY_PREDEF" tags are set to \c YES then this tag can be used to specify a list of macro names that should be expanded. The macro definition that is found in the sources will be used. - Use the \c PREDEFINED tag if you want to use a different macro definition. + Use the \ref cfg_predefined "PREDEFINED" tag if you want to use a different macro definition. \anchor cfg_skip_function_macros
    \c SKIP_FUNCTION_MACROS
    @@ -2473,7 +2497,7 @@ front of it. If left blank docbook will be used as the default path. See \ref external for more information about the use of tag files. \note - Each tag file must have a unique name + Each tag file must have an unique name (where the name does \e not include the path). If a tag file is not located in the directory in which doxygen is run, you must also specify the path to the tagfile here. @@ -2523,8 +2547,8 @@ front of it. If left blank docbook will be used as the default path. 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 also works with \c HAVE_DOT disabled, but it is recommended to -install and use dot, since it yields more powerful graphs. +this option also works with \ref cfg_have_dot "HAVE_DOT" disabled, but it is recommended to +install and use \c dot, since it yields more powerful graphs. \anchor cfg_mscgen_path
    \c MSCGEN_PATH
    @@ -2538,16 +2562,16 @@ install and use dot, since it yields more powerful graphs. \anchor cfg_have_dot
    \c HAVE_DOT
    \addindex HAVE_DOT - If you set the \c HAVE_DOT tag to \c YES then doxygen will assume the dot tool is - available from the path. This tool is part of - Graphviz, a graph + If you set the \c HAVE_DOT tag to \c YES then doxygen will assume the \c dot tool is + available from the \c path. This tool is part of + Graphviz, a graph visualization toolkit from AT\&T and Lucent Bell Labs. The other options in this section have no effect if this option is set to \c NO (the default) \anchor cfg_dot_num_threads
    \c DOT_NUM_THREADS
    \addindex DOT_NUM_THREADS - The \c DOT_NUM_THREADS specifies the number of dot invocations doxygen is + The \c DOT_NUM_THREADS specifies the number of \c dot invocations doxygen is allowed to run in parallel. When set to 0 (the default) doxygen will base this on the number of processors available in the system. You can set it explicitly to a value larger than 0 to get control over the balance @@ -2561,7 +2585,7 @@ install and use dot, since it yields more powerful graphs. When you want a differently looking font you can specify the font name using \c DOT_FONTNAME. You need to make sure dot is able to find the font, which can be done by putting it in a standard location or by setting the - \c DOTFONTPATH environment variable or by setting \c DOT_FONTPATH to the + \c DOTFONTPATH environment variable or by setting \ref cfg_dot_fontpath "DOT_FONTPATH" to the directory containing the font. \anchor cfg_dot_fontsize @@ -2572,23 +2596,23 @@ The default size is 10pt. \anchor cfg_dot_fontpath
    \c DOT_FONTPATH
    \addindex DOT_FONTPATH - By default doxygen will tell dot to use the output directory to look for the + By default doxygen will tell \c dot to use the output directory to look for the \c FreeSans.ttf font (which doxygen will put there itself). If you specify a - different font using \c DOT_FONTNAME you can set the path where dot + different font using \ref cfg_dot_fontname "DOT_FONTNAME" you can set the path where \c dot can find it using this tag. \anchor cfg_class_graph
    \c CLASS_GRAPH
    \addindex CLASS_GRAPH - If the \c CLASS_GRAPH and \c HAVE_DOT tags are set to \c YES then doxygen + If the \c CLASS_GRAPH and \ref cfg_have_dot "HAVE_DOT" tags are set to \c YES then doxygen will generate a graph for each documented class showing the direct and indirect inheritance relations. Setting this tag to \c YES will force - the \c CLASS_DIAGRAMS tag to \c NO. + the \ref cfg_class_diagrams "CLASS_DIAGRAMS" tag to \c NO. \anchor cfg_collaboration_graph
    \c COLLABORATION_GRAPH
    \addindex COLLABORATION_GRAPH - If the \c COLLABORATION_GRAPH and \c HAVE_DOT tags are set to \c YES then doxygen + If the \c COLLABORATION_GRAPH and \ref cfg_have_dot "HAVE_DOT" are set to \c YES then doxygen will generate a graph for each documented class showing the direct and indirect implementation dependencies (inheritance, containment, and class references variables) of the class with other documented classes. @@ -2596,20 +2620,20 @@ The default size is 10pt. \anchor cfg_group_graphs
    \c GROUP_GRAPHS
    \addindex GROUP_GRAPHS - If the GROUP_GRAPHS and HAVE_DOT tags are set to \c YES then doxygen + If the \c GROUP_GRAPHS and \ref cfg_have_dot "HAVE_DOT" tags are set to \c YES then doxygen will generate a graph for groups, showing the direct groups dependencies. \anchor cfg_uml_look
    \c UML_LOOK
    \addindex UML_LOOK - If the UML_LOOK tag is set to \c YES doxygen will generate inheritance and + If the \c UML_LOOK tag is set to \c YES doxygen will generate inheritance and collaboration diagrams in a style similar to the OMG's Unified Modeling Language. \anchor cfg_uml_limit_num_fields
    \c UML_LIMIT_NUM_FIELDS
    \addindex UML_LIMIT_NUM_FIELDS - If the \c UML_LOOK tag is enabled, the fields and methods are shown inside + If the \ref cfg_uml_look "UML_LOOK" tag is enabled, the fields and methods are shown inside the class node. If there are many fields or methods and many nodes the graph may become too big to be useful. The \c UML_LIMIT_NUM_FIELDS threshold limits the number of items for each type to make the size more @@ -2621,7 +2645,7 @@ The default size is 10pt. \anchor cfg_template_relations
    \c TEMPLATE_RELATIONS
    \addindex TEMPLATE_RELATIONS - If the \c TEMPLATE_RELATIONS and \c HAVE_DOT tags are set to \c YES then + If the \c TEMPLATE_RELATIONS and \ref cfg_have_dot "HAVE_DOT" tags are set to \c YES then doxygen will show the relations between templates and their instances. \anchor cfg_hide_undoc_relations @@ -2634,7 +2658,9 @@ The default size is 10pt. \anchor cfg_include_graph
    \c INCLUDE_GRAPH
    \addindex INCLUDE_GRAPH - If the \c ENABLE_PREPROCESSING, \c SEARCH_INCLUDES, \c INCLUDE_GRAPH, and \c HAVE_DOT + If the \ref cfg_enable_preprocessing "ENABLE_PREPROCESSING", + \ref cfg_search_includes "SEARCH_INCLUDES", \ref cfg_include_graph "INCLUDE_GRAPH", + and \ref cfg_have_dot "HAVE_DOT" tags are set to \c YES then doxygen will generate a graph for each documented file showing the direct and indirect include dependencies of the file with other documented files. @@ -2642,41 +2668,42 @@ The default size is 10pt. \anchor cfg_included_by_graph
    \c INCLUDED_BY_GRAPH
    \addindex INCLUDED_BY_GRAPH - If the \c ENABLE_PREPROCESSING, \c SEARCH_INCLUDES, \c INCLUDED_BY_GRAPH, and - \c HAVE_DOT tags are set to \c YES then doxygen will generate a graph for each + If the \ref cfg_enable_preprocessing "ENABLE_PREPROCESSING", + \ref cfg_search_includes "SEARCH_INCLUDES", \ref cfg_include_graph "INCLUDED_BY_GRAPH", and + \ref cfg_have_dot "HAVE_DOT" tags are set to \c YES then doxygen will generate a graph for each documented header file showing the documented files that directly or indirectly include this file. \anchor cfg_call_graph
    \c CALL_GRAPH
    \addindex CALL_GRAPH - If the \c CALL_GRAPH and \c HAVE_DOT tags are set to \c YES then doxygen will + If the \c CALL_GRAPH and \ref cfg_have_dot "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. + functions only using the \ref cmdcallgraph "\\callgraph" command. \anchor cfg_caller_graph
    \c CALLER_GRAPH
    \addindex CALLER_GRAPH - If the \c CALLER_GRAPH and \c HAVE_DOT tags are set to \c YES then doxygen will + If the \c CALLER_GRAPH and \ref cfg_have_dot "HAVE_DOT" tags are set to \c YES then doxygen will generate a caller 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 caller graphs for selected - functions only using the \\callergraph command. + functions only using the \ref cmdcallergraph "\\callergraph" command. \anchor cfg_graphical_hierarchy
    \c GRAPHICAL_HIERARCHY
    \addindex GRAPHICAL_HIERARCHY - If the \c GRAPHICAL_HIERARCHY and \c HAVE_DOT tags are set to \c YES then + If the \c GRAPHICAL_HIERARCHY and \ref cfg_have_dot "HAVE_DOT" tags are set to \c YES then doxygen will graphical hierarchy of all classes instead of a textual one. \anchor cfg_directory_graph
    \c DIRECTORY_GRAPH
    \addindex DIRECTORY_GRAPH - If the \c DIRECTORY_GRAPH, and \c HAVE_DOT options are set + If the \c DIRECTORY_GRAPH, and \ref cfg_have_dot "HAVE_DOT" options are set to \c YES then doxygen will show the dependencies a directory has on other directories - in a graphical way. The dependency relations are determined by the \#include + in a graphical way. The dependency relations are determined by the \c \#include relations between the files in the directories. \anchor cfg_dot_graph_max_nodes @@ -2688,43 +2715,43 @@ The default size is 10pt. visualized by representing a node as a red box. Note that doxygen if the number of direct children of the root node in a graph is already larger than \c DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note - that the size of a graph can be further restricted by \c MAX_DOT_GRAPH_DEPTH. + that the size of a graph can be further restricted by \ref cfg_max_dot_graph_depth "MAX_DOT_GRAPH_DEPTH". \anchor cfg_max_dot_graph_depth
    \c MAX_DOT_GRAPH_DEPTH
    \addindex MAX_DOT_GRAPH_DEPTH The \c MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the - graphs generated by dot. A depth value of 3 means that only nodes reachable + graphs generated by \c dot. A depth value of 3 means that only nodes reachable from the root by following a path via at most 3 edges will be shown. Nodes that lay further from the root node will be omitted. Note that setting this option to 1 or 2 may greatly reduce the computation time needed for large code bases. Also note that the size of a graph can be further restricted by - \c DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction (the default). + \ref cfg_dot_graph_max_nodes "DOT_GRAPH_MAX_NODES". Using a depth of 0 means no depth restriction (the default). \anchor cfg_dot_image_format
    \c DOT_IMAGE_FORMAT
    \addindex DOT_IMAGE_FORMAT The \c DOT_IMAGE_FORMAT tag can be used to set the image format of the images - generated by dot. Possible values are svg, png, jpg, or gif. + generated by \c dot. Possible values are \c svg, \c png, \c jpg, or \c gif. If left blank png will be used. \note If you choose \c svg you need to set - HTML_FILE_EXTENSION to xhtml in order to make the SVG files + \ref cfg_html_file_extension "HTML_FILE_EXTENSION" to \c xhtml in order to make the SVG files visible in IE 9+ (other browsers do not have this requirement). \anchor cfg_interactive_svg
    \c INTERACTIVE_SVG
    - If DOT_IMAGE_FORMAT is set to svg, then this option can be set to \c YES to + If \ref cfg_dot_image_format "DOT_IMAGE_FORMAT" is set to \c svg, then this option can be set to \c YES to enable generation of interactive SVG images that allow zooming and panning. Note that this requires a modern browser other than Internet Explorer. Tested and working are Firefox, Chrome, Safari, and Opera. - \note For IE 9+ you need to set \c HTML_FILE_EXTENSION to xhtml in order + \note For IE 9+ you need to set \ref cfg_html_file_extension "HTML_FILE_EXTENSION" to xhtml in order to make the SVG files visible. Older versions of IE do not have SVG support. \anchor cfg_dot_path
    \c DOT_PATH
    \addindex DOT_PATH - This tag can be used to specify the path where the dot tool can be found. - If left blank, it is assumed the dot tool can be found on the path. + This tag can be used to specify the path where the \c dot tool can be found. + If left blank, it is assumed the \c dot tool can be found in the \c path. \anchor cfg_dotfile_dirs
    \c DOTFILE_DIRS
    @@ -2754,7 +2781,7 @@ The default size is 10pt. \addindex DOT_MULTI_TARGET Set the \c DOT_MULTI_TARGETS tag to \c YES allow dot to generate multiple output files in one run (i.e. multiple -o and -T options on the command line). This - makes dot run faster, but since only newer versions of dot (>1.8.10) + makes \c dot run faster, but since only newer versions of \c dot (>1.8.10) support this, this feature is disabled by default. \anchor cfg_generate_legend @@ -2781,7 +2808,7 @@ Then a minimal configuration file is as simple as: INPUT = example.cc example.h \endverbatim -Assuming the example makes use of Qt classes and perl is located +Assuming the example makes use of Qt classes and \c perl is located in /usr/bin, a more realistic configuration file would be: \verbatim PROJECT_NAME = Example diff --git a/doc/faq.doc b/doc/faq.doc index 79e6585..a4308b6 100644 --- a/doc/faq.doc +++ b/doc/faq.doc @@ -274,7 +274,7 @@ documentation -> docs -> dox generator -> gen \endverbatim -At the time I was looking into lex and yacc, where a lot of things start with +At the time I was looking into \c lex and \c yacc, where a lot of things start with "yy", so the "y" slipped in and made things pronounceable (the proper pronouncement is Docs-ee-gen, so with a long "e"). diff --git a/doc/htmlcmds.doc b/doc/htmlcmds.doc index 6b7172d..6fe96fe 100644 --- a/doc/htmlcmds.doc +++ b/doc/htmlcmds.doc @@ -20,7 +20,7 @@ Here is a list of all HTML commands that may be used inside the documentation. Note that although these HTML tags are translated to the proper commands for output formats other than HTML, all attributes of a HTML tag are passed on to the HTML output only -(the HREF and NAME attributes for the A tag are the only exception). +(the \c HREF and \c NAME attributes for the \c A tag are the only exception).