diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/CMakeLists.txt | 1 | ||||
| -rw-r--r-- | doc/changelog.doc | 10 | ||||
| -rw-r--r-- | doc/commands.doc | 14 | ||||
| -rw-r--r-- | doc/customize.doc | 144 | ||||
| -rw-r--r-- | doc/faq.doc | 18 | ||||
| -rw-r--r-- | doc/features.doc | 2 | ||||
| -rw-r--r-- | doc/install.doc | 6 | ||||
| -rw-r--r-- | doc/install_prefix | 2 | ||||
| -rw-r--r-- | doc/preprocessing.doc | 4 | ||||
| -rw-r--r-- | doc/searching.doc | 6 | ||||
| -rw-r--r-- | doc/starting.doc | 7 | ||||
| -rw-r--r-- | doc/trouble.doc | 5 | ||||
| -rw-r--r-- | doc/xmlcmds.doc | 2 |
13 files changed, 124 insertions, 97 deletions
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index f2d177e..f7f680f 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -82,7 +82,6 @@ set(DOC_FILES infoflow.fig infoflow.png install.doc - install_prefix lists.doc markdown.doc output.doc diff --git a/doc/changelog.doc b/doc/changelog.doc index 0d3dd2a..b2dc8fc 100644 --- a/doc/changelog.doc +++ b/doc/changelog.doc @@ -3774,7 +3774,7 @@ make sure you add the following: <li> id <a href="https://github.com/doxygen/doxygen/issues/4508">4508</a>: Added support for <inheritdoc/> C# XML command (thanks to John Werner for the patch).</li> <li> id <a href="https://github.com/doxygen/doxygen/issues/4588">4588</a>, Added support for resolving environment variables of the - form $(PROGRAMFILES(X86)) inside the config file</li> + form $(PROGRAMFILES(X86)) inside the config file</li> <li> Doxygen now shows Objective-C properties in collaboration diagrams (thanks to Sven Weidauer for the patch).</li> <li> Added ability to search for group or page titles.</li> @@ -5849,7 +5849,7 @@ make sure you add the following: <li> id 457857: Leading "struct" keyword is no longer stripped from the documentation of functions that return a pointer to a struct.</li> <li> id 458710: Expanding environment variables in the config file to a - file or path name with spaces (e.g. "$(VCInstallDir)include") was + file or path name with spaces (e.g. "$(VCInstallDir)include") was incorrectly interpreted as a list when used with for instance <code>INPUT</code>.</li> <li> id 458749: Undocumented constructors/destructors inside an undocumented member group were not visible in the output.</li> @@ -7264,7 +7264,7 @@ make sure you add the following: now be improved significantly.</li> <li> Made some cosmetic changes to the HTML output (thanks to Ben Harper).</li> <li> STRIP_FROM_PATH now by default strips the path from which doxygen is - run (i.e. $(PWD)/ on Unix)</li> + run (i.e. $(PWD)/ on Unix)</li> </ul> <h3>New features</h3> <ul> @@ -7315,7 +7315,7 @@ make sure you add the following: Eoin MacDonell for the fix).</li> <li> Grouped pages in the XML output did have the same id as their group.</li> <li> Fixed problem handling environment variables inside a - quoted string in the config file (e.g. "$(HOME)/My Path/").</li> + quoted string in the config file (e.g. "$(HOME)/My Path/").</li> <li> Using "\mainpage notitle" caused the "notitle" to appear in the treeview.</li> <li> Page references where wrong in the latex output when PDF_HYPERLINKS was disabled.</li> @@ -9166,7 +9166,7 @@ make sure you add the following: (thanks to Marvin Wolfthal).</li> <li> In some situations doxygen wanted to write a files containing a \n.</li> <li> Environment variables can now also be used for non-string values - in the config file, like for example QUIET = $(QUIET_ON)</li> + in the config file, like for example QUIET = $(QUIET_ON)</li> <li> Fixed a number of typo's in the docs (thanks to Philippe Lhoste & Jens Seidel).</li> <li> Inheritance through typedefs within a namespace did not yield the diff --git a/doc/commands.doc b/doc/commands.doc index 1465a1e..eff2f42 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -60,6 +60,7 @@ documentation: \refitem cmdcite \\cite \refitem cmdclass \\class \refitem cmdcode \\code +\refitem cmdconcept \\concept \refitem cmdcond \\cond \refitem cmdcopybrief \\copybrief \refitem cmdcopydetails \\copydetails @@ -457,6 +458,15 @@ Structural indicators \endlatexonly <hr> +\section cmdconcept \\concept <name> + + \addindex \\concept + Indicates that a comment block contains documentation for a + C++20 concept with name \<name\>. + See also the \ref cmdheaderfile "\\headerfile" command to specify the + header a user should be included to use the concept. + +<hr> \section cmddef \\def <name> \addindex \\def @@ -2132,7 +2142,7 @@ Make sure you have first read \ref intro "the introduction". \warning This command only works inside related page documentation and \e not in other documentation blocks and only has effect in the - the specified output! + specified output! <hr> \section cmdsection \\section <section-name> (section title) @@ -2558,7 +2568,7 @@ Commands for displaying examples \section cmdxmlinclude \\xmlinclude <file-name> \addindex \\xmlinclude - This command includes contents of the the file \<file-name\> as is in the XML documentation. + This command includes contents of the file \<file-name\> as is in the XML documentation. The command is equivalent to pasting the contents of the file in the documentation and placing \ref cmdxmlonly "\\xmlonly" and \ref cmdendxmlonly "\\endxmlonly" commands around it. diff --git a/doc/customize.doc b/doc/customize.doc index 52f8d7a..eebeb5c 100644 --- a/doc/customize.doc +++ b/doc/customize.doc @@ -1,12 +1,12 @@ /****************************************************************************** * - * + * * * Copyright (C) 1997-2015 by Dimitri van Heesch. * * Permission to use, copy, modify, and distribute this software and its - * documentation under the terms of the GNU General Public License is hereby - * granted. No representations are made about the suitability of this software + * documentation under the terms of the GNU General Public License is hereby + * granted. No representations are made about the suitability of this software * for any purpose. It is provided "as is" without express or implied warranty. * See the GNU General Public License for more details. * @@ -18,12 +18,12 @@ \tableofcontents{html,latex} -Doxygen provides various levels of customization. -The section \ref minor_tweaks "Minor Tweaks" discusses what to -do if you want to do minor tweaking to the look and feel of the output. -The section \ref layout "Layout" show how to reorder and hide certain -information on a page. -The section \ref xmlgenerator "XML output" show how to generate +Doxygen provides various levels of customization. +The section \ref minor_tweaks "Minor Tweaks" discusses what to +do if you want to do minor tweaking to the look and feel of the output. +The section \ref layout "Layout" show how to reorder and hide certain +information on a page. +The section \ref xmlgenerator "XML output" show how to generate whatever output you want based on the XML output produced by doxygen. \section minor_tweaks Minor Tweaks @@ -40,8 +40,8 @@ To change the overall color of the HTML output doxygen provides three options to change the hue, saturation, and gamma correction of the colors respectively. -For your convenience the GUI frontend \ref doxywizard_usage "Doxywizard" -has a control that allows you to see the effect of changing the values of these options +For your convenience the GUI frontend \ref doxywizard_usage "Doxywizard" +has a control that allows you to see the effect of changing the values of these options on the output in real time. \subsection minor_tweaks_treeview Navigation @@ -78,10 +78,10 @@ then you can also disable all indices, like so: To make the HTML output more interactive, doxygen provides a number of options that are disabled by default: - enabling \ref cfg_html_dynamic_sections "HTML_DYNAMIC_SECTIONS" will make - doxygen hide certain content (like graphs) in the HTML by default, + doxygen hide certain content (like graphs) in the HTML by default, and let the reader expand these sections on request. -- enabling \ref cfg_have_dot "HAVE_DOT" along - with \ref cfg_interactive_svg "INTERACTIVE_SVG" while setting +- enabling \ref cfg_have_dot "HAVE_DOT" along + with \ref cfg_interactive_svg "INTERACTIVE_SVG" while setting \ref cfg_dot_image_format "DOT_IMAGE_FORMAT" to \c svg, will make doxygen produce SVG images that will allow the user to zoom and pan (this only happens when the size of the images exceeds a certain size). @@ -89,24 +89,24 @@ that are disabled by default: \subsection minor_tweaks_header_css Header, Footer, and Stylesheet changes To tweak things like fonts or colors, margins, or other look \& feel -aspects of the HTML output in detail, you can create a different -<a href="https://www.w3schools.com/css/default.asp">cascading style sheet</a>. -You can also let doxygen use a custom header and footer for each HTML -page it generates, for instance to make the output conform to the style +aspects of the HTML output in detail, you can create a different +<a href="https://www.w3schools.com/css/default.asp">cascading style sheet</a>. +You can also let doxygen use a custom header and footer for each HTML +page it generates, for instance to make the output conform to the style used on the rest of your web site. To do this first run doxygen as follows: \verbatim -doxygen -w html header.html footer.html customdoxygen.css +doxygen -w html header.html footer.html customdoxygen.css \endverbatim This will create 3 files: - header.html is a HTML fragment which doxygen normally uses to start a HTML page. Note that the fragment ends with a body tag and that is contains a couple of commands of the form \$word. These will be replaced - by doxygen on the fly. -- footer.html is a HTML fragment which doxygen normally uses to end - a HTML page. Also here special commands can be used. This file contain the + by doxygen on the fly. +- footer.html is a HTML fragment which doxygen normally uses to end + a HTML page. Also here special commands can be used. This file contain the link to www.doxygen.org and the body and html end tags. - customdoxygen.css is the default cascading style sheet used by doxygen. It is recommended only to look into this file and overrule @@ -128,7 +128,7 @@ for more information about the possible meta commands you can use inside your custom header. \note You should not put the style sheet in the HTML output directory. Treat -it as a source file. Doxygen will copy it for you. +it as a source file. Doxygen will copy it for you. \note If you use images or other external content in a custom header you need to make sure these end up in the HTML output directory yourself, @@ -136,24 +136,24 @@ for instance by writing a script that runs doxygen can then copies the images to the output. \warning The structure of headers and footers may change after upgrading to -a newer version of doxygen, so if you are using a custom header or footer, -it might not produce valid output anymore after upgrading. +a newer version of doxygen, so if you are using a custom header or footer, +it might not produce valid output anymore after upgrading. \section layout Changing the layout of pages In some cases you may want to change the way the output is structured. -A different style sheet or custom headers and footers do not help in such +A different style sheet or custom headers and footers do not help in such case. The solution doxygen provides is a layout file, which you can -modify and doxygen will use to control what information is presented, +modify and doxygen will use to control what information is presented, in which order, and to some extent also how information is presented. -The layout file is an XML file. +The layout file is an XML file. The default layout can be generated by doxygen using the following command: \verbatim -doxygen -l +doxygen -l \endverbatim optionally the name of the layout file can be specified, if omitted \c DoxygenLayout.xml will be used. @@ -192,25 +192,25 @@ The root element of the XML file is \c doxygenlayout, it has an attribute named \c version, which will be used in the future to cope with changes that are not backward compatible. -The first section, identified by the \c navindex element, represents the +The first section, identified by the \c navindex element, represents the layout of the navigation tabs displayed at the top of each HTML page. At the same time it also controls the items in the navigation tree in case -\ref cfg_generate_treeview "GENERATE_TREEVIEW" is enabled. +\ref cfg_generate_treeview "GENERATE_TREEVIEW" is enabled. Each tab is represented by a \c tab element in the XML file. -You can hide tabs by setting the \c visible attribute to \c no. -You can also override the default title of a tab by specifying it as +You can hide tabs by setting the \c visible attribute to \c no. +You can also override the default title of a tab by specifying it as the value of the \c title attribute. If the title field is the empty string (the default) then doxygen will fill in an appropriate language specific title. You can reorder the tabs by moving the tab elements in the XML file -within the \c navindex element and even change the tree structure. -Do not change the value of the \c type attribute however. -Only a fixed set of types are supported, each representing a link to a +within the \c navindex element and even change the tree structure. +Do not change the value of the \c type attribute however. +Only a fixed set of types are supported, each representing a link to a specific index. You can also add custom tabs using a type with name "user". Here is an -example that shows how to add a tab with title "Google" pointing to +example that shows how to add a tab with title "Google" pointing to www.google.com: \verbatim @@ -222,9 +222,9 @@ www.google.com: \endverbatim The url field can also be a relative URL. If the URL starts with \@ref -the link will point to a documented entities, such as a class, a function, -a group, or a related page. Suppose we have defined a page using \@page with -label mypage, then a tab with label "My Page" to this page would look +the link will point to a documented entities, such as a class, a function, +a group, or a related page. Suppose we have defined a page using \@page with +label mypage, then a tab with label "My Page" to this page would look as follows: \verbatim @@ -250,7 +250,7 @@ defined group with title "My Group": </navindex> \endverbatim -Groups can be nested to form a hierarchy. +Groups can be nested to form a hierarchy. By default a usergroup entry in the navigation tree is a link to a landing page with the contents of the group. You can link to a @@ -263,7 +263,7 @@ different page using the `url` attribute just like you can for the </tab> \endverbatim -The elements after \c navindex represent the layout of the different +The elements after \c navindex represent the layout of the different pages generated by doxygen: - The \c class element represents the layout of all pages generated for documented classes, structs, unions, and interfaces. @@ -279,8 +279,8 @@ pages generated by doxygen: Each XML element within one of the above page elements represents a certain piece of information. Some pieces can appear in each type of page, others are specific for a certain type of page. -Doxygen will list the pieces in the order in which they appear -in the XML file. +Doxygen will list the pieces in the order in which they appear +in the XML file. The following generic elements are possible for each page: <dl> @@ -298,25 +298,25 @@ The following generic elements are possible for each page: <dt>\c memberdecl <dd>Represents the quick overview of members on a page (member declarations). This elements has child elements per type of member list. - The possible child elements are not listed in detail in the document, - but the name of the element should be a good indication of the type + The possible child elements are not listed in detail in the document, + but the name of the element should be a good indication of the type of members that the element represents. <dt>\c memberdef <dd>Represents the detailed member list on a page (member definition). - Like the \c memberdecl element, also this element has a number of - possible child elements. + Like the \c memberdecl element, also this element has a number of + possible child elements. </dl> The class page has the following specific elements: <dl> <dt>\c includes - <dd>Represents the include file needed to obtain the definition for + <dd>Represents the include file needed to obtain the definition for this class. <dt>\c inheritancegraph - <dd>Represents the inheritance relations for a class. + <dd>Represents the inheritance relations for a class. Note that the CLASS_DIAGRAM option determines if the inheritance relation is a list of base and derived classes or - a graph. + a graph. <dt>\c collaborationgraph <dd>Represents the collaboration graph for a class. <dt>\c allmemberslink @@ -341,14 +341,14 @@ The file page has the following specific elements: The group page has a specific \c groupgraph element which represents the graph showing the dependencies between groups. -Similarly, the directory page has a specific \c directorygraph element -which represents the graph showing the dependencies between the directories +Similarly, the directory page has a specific \c directorygraph element +which represents the graph showing the dependencies between the directories based on the \#include relations of the files inside the directories. -Some elements have a \c visible attribute which can be +Some elements have a \c visible attribute which can be used to hide the fragment from the generated output, by setting the attribute's -value to "no". You can also use the value of a configuration option to -determine the visibility, by using +value to "no". You can also use the value of a configuration option to +determine the visibility, by using its name prefixed with a dollar sign, e.g. \verbatim ... @@ -356,15 +356,15 @@ its name prefixed with a dollar sign, e.g. ... \endverbatim This was mainly added for backward compatibility. -Note that the \c visible attribute is just a hint for doxygen. -If no relevant information is available for a certain piece it is -omitted even if it is set to \c yes (i.e. no empty sections are generated). +Note that the \c visible attribute is just a hint for doxygen. +If no relevant information is available for a certain piece it is +omitted even if it is set to \c yes (i.e. no empty sections are generated). Some elements have a \c title attribute. This attribute can be used to customize the title doxygen will use as a header for the piece. @warning at the moment you should not remove elements from the layout file -as a way to hide information. Doing so can cause broken links in the +as a way to hide information. Doing so can cause broken links in the generated output! @@ -378,27 +378,29 @@ generate the output you like. To do this set The XML output consists of an index file named \c index.xml which lists all items extracted by doxygen with references to the other XML files for details. The structure of the index is described by a schema file -\c index.xsd. All other XML files are described by the schema file -named \c compound.xsd. If you prefer one big XML file -you can combine the index and the other files using the +\c index.xsd. All other XML files are described by the schema file +named \c compound.xsd. If you prefer one big XML file +you can combine the index and the other files using the XSLT file \c combine.xslt. -You can use any XML parser to parse the file or use the one that can be found -in the \c addon/doxmlparser directory of doxygen source distribution. -Look at \c addon/doxmlparser/include/doxmlintf.h for the interface of the -parser and in \c addon/doxmlparser/example for examples. +You can use any XML parser to parse the files or use the one that can be found +in the \c addon/doxmlparser directory of doxygen's source distribution. +Look at \c addon/doxmlparser/doxmlparser/index.py and +\c addon/doxmlparser/doxmlparser/compound.py for the interface of the +parser (it is generated by <a href="https://www.davekuhlman.org/generateDS.html">generatedDS</a> +and follows the XML schema files \c index.xsd and \c compound.xsd found in +\c templates/xml). Look in \c addon/doxmlparser/examples for examples. The advantage of using the doxmlparser is that it -will only read the index file into memory and then only those XML -files that you implicitly load via navigating through the index. As a +allows you to only read the index file into memory and then only those XML +files that you implicitly load via navigating through the index. As a result this works even for very large projects where reading all XML files as one big DOM tree would not fit into memory. See <a href="https://github.com/michaeljones/breathe">the Breathe project</a> for -an example that uses doxygen XML output from Python to bridge it with the +an example that uses doxygen XML output from Python to bridge it with the <a href="http://www.sphinx-doc.org/en/stable/">Sphinx</a> document generator. - \htmlonly Go to the <a href="custcmd.html">next</a> section or return to the <a href="index.html">index</a>. diff --git a/doc/faq.doc b/doc/faq.doc index 95de571..16765ce 100644 --- a/doc/faq.doc +++ b/doc/faq.doc @@ -184,13 +184,11 @@ in the HEAD section of the HTML page. \section faq_use_qt Why does doxygen use Qt? -The most important reason is to have a platform abstraction for most -Unices and Windows by means of the QFile, QFileInfo, QDir, QDate, -QTime and QIODevice classes. -Another reason is for the nice and bug free utility classes, like QList, -QDict, QString, QArray, QTextStream, QRegExp, QXML etc. +In the past (prior to version 1.9.2) doxygen used a part of Qt 2.x for various +utility classes. These have been replaced by STL container classes in the meantime. -The GUI front-end doxywizard uses Qt for... well... the GUI! +The GUI front-end called Doxywizard is based on a modern version of Qt. +Doxygen itself can also be used without the GUI. \section faq_excl_dir How can I exclude all test directories from my directory tree? @@ -306,6 +304,14 @@ Doc++ but that just wasn't good enough (it didn't support signals and slots and did not have the Qt look and feel I had grown to like), so I started to write my own tool... +\section faq_bin How to prevent interleaved output + +When redirecting all the console output of doxygen, i.e. messages and warnings, this can be interleaved or +in a non-expected order. +The, technical, reason for this is that the `stdout` can be buffered. +It is possible to overcome this by means of the `-b` of doxygen, like e.g `doxygen -b > out.txt 2>&1`. +Note this might cost a little more time though. + \htmlonly Go to the <a href="trouble.html">next</a> section or return to the <a href="index.html">index</a>. diff --git a/doc/features.doc b/doc/features.doc index e746ac3..9c42d5b 100644 --- a/doc/features.doc +++ b/doc/features.doc @@ -28,7 +28,7 @@ output even from undocumented code. <li>Generates structured XML output for parsed sources, which can be used by external tools. -<li>Supports C/C++, Java, (Corba and Microsoft) Java, Python, VHDL, PHP +<li>Supports C/C++, Lex, Java, (Corba and Microsoft) Java, Python, VHDL, PHP IDL, C#, Fortran, Objective-C 2.0, and to some extent D sources. <li>Supports documentation of files, namespaces, packages, classes, structs, unions, templates, variables, functions, typedefs, enums and diff --git a/doc/install.doc b/doc/install.doc index 99cecc6..53c4466 100644 --- a/doc/install.doc +++ b/doc/install.doc @@ -229,8 +229,10 @@ of the GraphViz package to render nicer diagrams, see the If you want to produce compressed HTML files (see \ref cfg_generate_htmlhelp "GENERATE_HTMLHELP") in the configuration file, then you need the Microsoft HTML help workshop. -You can download it from -<a href="https://www.microsoft.com/en-us/download/details.aspx?id=21138">Microsoft</a>. +In the beginning of 2021 Microsoft took the original page, with a.o. the download links, +offline the HTML help workshop was already many years in maintenance mode). +You can download the HTML help workshop from the web archives at +<a href="http://web.archive.org/web/20160201063255/http://download.microsoft.com/download/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe">Installation executable</a>. If you want to produce Qt Compressed Help files (see \ref cfg_qhg_location "QHG_LOCATION") in the configuration file, then diff --git a/doc/install_prefix b/doc/install_prefix deleted file mode 100644 index 681eca9..0000000 --- a/doc/install_prefix +++ /dev/null @@ -1,2 +0,0 @@ -VERSION = $(VERSION) - diff --git a/doc/preprocessing.doc b/doc/preprocessing.doc index 4df83ff..34aa3ed 100644 --- a/doc/preprocessing.doc +++ b/doc/preprocessing.doc @@ -259,6 +259,10 @@ you can run doxygen as follows: \verbatim doxygen -d Preprocessor \endverbatim +or when the line numbers are not wanted: +\verbatim + doxygen -d Preprocessor -d NoLineno +\endverbatim This will instruct doxygen to dump the input sources to standard output after preprocessing has been done (Hint: set <code>QUIET = YES</code> and <code>WARNINGS = NO</code> in the configuration file to disable any other diff --git a/doc/searching.doc b/doc/searching.doc index 880c3f4..1bdb12d 100644 --- a/doc/searching.doc +++ b/doc/searching.doc @@ -43,8 +43,12 @@ has its own advantages and disadvantages: searching, i.e. the search results are presented and adapted as you type. This method also has its drawbacks: it is limited to searching for symbols - only. It does not provide full text search capabilities, and it does not + only. It does not provide full text search capabilities and it does not scale well to very large projects (then searching becomes very slow). + Furthermore the searching is done from the beginning of the indexed items, so + when having the available items `A_STRING`, `AA_STRING` and `STRING` and + typing in the search box `A` it will find `A_STRING` and `AA_STRING`, but when + typing e.g. `STR` it will only find `STRING` and not `A_STRING`. <h2>2. Server side searching</h2> If you plan to put the HTML documentation on a web server, and that diff --git a/doc/starting.doc b/doc/starting.doc index 3ae2692..44f2a92 100644 --- a/doc/starting.doc +++ b/doc/starting.doc @@ -37,7 +37,7 @@ tries to be complete): \section step0 Step 0: Check if doxygen supports your programming language First, assure that your programming language has a reasonable chance of being -recognized by doxygen. These languages are supported by default: C, C++, C#, +recognized by doxygen. These languages are supported by default: C, C++, Lex, C#, Objective-C, IDL, Java, VHDL, PHP, Python, Fortran and D. It is possible to configure certain file type extensions to use certain parsers: see the \ref cfg_extension_mapping "Configuration/ExtensionMappings" for details. @@ -120,7 +120,7 @@ Extension | Language | Extension | Language | Extension | Language .ixx |C / C++ | .php5 |PHP | .vhdl |VHDL .ipp |C / C++ | .inc |PHP | .ucf |VHDL .i++ |C / C++ | .phtml |PHP | .qsf |VHDL -.inl |C / C++ | .m |Objective-C | | +.inl |C / C++ | .m |Objective-C | .l |Lex .h |C / C++ | .M |Objective-C | .md |Markdown .H |C / C++ | .py |Python | .markdown |Markdown .hh |C / C++ | .pyw |Python | .ice |Slice @@ -249,7 +249,8 @@ files and can be used for validation or to steer XSLT scripts. In the `addon/doxmlparser` directory you can find a parser library for reading the XML output produced by doxygen in an incremental way -(see `addon/doxmlparser/include/doxmlintf.h` for the interface of the library) +(see `addon/doxmlparser/doxmparser/index.py` and `addon/doxmlparser/doxmlparser/compound.py` +for the interface of the library) \subsection man_out Man page output \addindex man diff --git a/doc/trouble.doc b/doc/trouble.doc index cb50399..a2e9be6 100644 --- a/doc/trouble.doc +++ b/doc/trouble.doc @@ -34,7 +34,7 @@ or unions with the same name in your code. It should not crash however, rather it should ignore all of the classes with the same name except one. <li>Some commands do not work inside the arguments of other commands. - Inside a HTML link (i.e. \<a href="..."\>...\<a\>) for instance + Inside a HTML link (i.e. \<a href="..."\>...\</a\>) for instance other commands (including other HTML commands) do not work! The sectioning commands are an important exception. <li>Redundant braces can confuse doxygen in some cases. @@ -106,7 +106,8 @@ helpful and it will cost me much more time to figure out what you mean. In the worst-case your bug report may even be completely ignored by me, so always try to include the following information in your bug report: - The version of doxygen you are using (for instance 1.5.3, use - `doxygen --version` if you are not sure). + `doxygen --version` if you are not sure or `doxygen --Version` for a bit + more information). - The name and version number of your operating system (for instance Ubuntu Linux 18.04 LTS) - It is usually a good idea to send along the configuration file as well, diff --git a/doc/xmlcmds.doc b/doc/xmlcmds.doc index 3a58301..6cb78bd 100644 --- a/doc/xmlcmds.doc +++ b/doc/xmlcmds.doc @@ -18,7 +18,7 @@ Doxygen supports most of the XML commands that are typically used in C# code comments. The XML tags are defined in Appendix D of the -<a href="http://www.ecma-international.org/publications/standards/Ecma-334.htm">ECMA-334</a> +<a href="https://www.ecma-international.org/publications-and-standards/standards/ecma-334/">ECMA-334</a> standard, which defines the C# language. Unfortunately, the specification is not very precise and a number of the examples given are of poor quality. |