diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/Makefile.in | 2 | ||||
-rw-r--r-- | doc/Makefile.latex | 2 | ||||
-rw-r--r-- | doc/Makefile.win_make.in | 2 | ||||
-rw-r--r-- | doc/Makefile.win_nmake.in | 2 | ||||
-rw-r--r-- | doc/arch.doc | 2 | ||||
-rw-r--r-- | doc/autolink.doc | 6 | ||||
-rw-r--r-- | doc/commands.doc | 52 | ||||
-rw-r--r-- | doc/config.doc | 33 | ||||
-rw-r--r-- | doc/custcmd.doc | 4 | ||||
-rw-r--r-- | doc/customize.doc | 14 | ||||
-rw-r--r-- | doc/diagrams.doc | 2 | ||||
-rw-r--r-- | doc/docblocks.doc | 7 | ||||
-rw-r--r-- | doc/doxygen.1 | 2 | ||||
-rw-r--r-- | doc/doxygen_manual.css | 54 | ||||
-rw-r--r-- | doc/doxygen_manual.tex | 3 | ||||
-rw-r--r-- | doc/doxygen_usage.doc | 2 | ||||
-rw-r--r-- | doc/doxywizard_usage.doc | 4 | ||||
-rw-r--r-- | doc/external.doc | 2 | ||||
-rw-r--r-- | doc/faq.doc | 2 | ||||
-rw-r--r-- | doc/features.doc | 4 | ||||
-rw-r--r-- | doc/formulas.doc | 2 | ||||
-rw-r--r-- | doc/grouping.doc | 2 | ||||
-rw-r--r-- | doc/htmlcmds.doc | 4 | ||||
-rw-r--r-- | doc/index.doc | 4 | ||||
-rw-r--r-- | doc/install.doc | 22 | ||||
-rw-r--r-- | doc/language.doc | 2 | ||||
-rw-r--r-- | doc/markdown.doc | 76 | ||||
-rw-r--r-- | doc/output.doc | 2 | ||||
-rw-r--r-- | doc/preprocessing.doc | 4 | ||||
-rw-r--r-- | doc/searching.doc | 4 | ||||
-rw-r--r-- | doc/starting.doc | 6 | ||||
-rw-r--r-- | doc/translator_report.txt | 3 | ||||
-rw-r--r-- | doc/trouble.doc | 4 | ||||
-rw-r--r-- | doc/xmlcmds.doc | 2 |
34 files changed, 214 insertions, 124 deletions
diff --git a/doc/Makefile.in b/doc/Makefile.in index 5e0f9aa..aaa9b0e 100644 --- a/doc/Makefile.in +++ b/doc/Makefile.in @@ -1,7 +1,7 @@ # # # -# Copyright (C) 1997-2011 by Dimitri van Heesch. +# Copyright (C) 1997-2012 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 diff --git a/doc/Makefile.latex b/doc/Makefile.latex index 55f275d..a13b90f 100644 --- a/doc/Makefile.latex +++ b/doc/Makefile.latex @@ -1,7 +1,7 @@ # # # -# Copyright (C) 1997-2011 by Dimitri van Heesch. +# Copyright (C) 1997-2012 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 diff --git a/doc/Makefile.win_make.in b/doc/Makefile.win_make.in index 02c5335..07c0679 100644 --- a/doc/Makefile.win_make.in +++ b/doc/Makefile.win_make.in @@ -1,7 +1,7 @@ # # # -# Copyright (C) 1997-2011 by Dimitri van Heesch. +# Copyright (C) 1997-2012 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 diff --git a/doc/Makefile.win_nmake.in b/doc/Makefile.win_nmake.in index e98c46f..af8711c 100644 --- a/doc/Makefile.win_nmake.in +++ b/doc/Makefile.win_nmake.in @@ -1,7 +1,7 @@ # # # -# Copyright (C) 1997-2011 by Dimitri van Heesch. +# Copyright (C) 1997-2012 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 diff --git a/doc/arch.doc b/doc/arch.doc index cdaf7b7..f89b12a 100644 --- a/doc/arch.doc +++ b/doc/arch.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2011 by Dimitri van Heesch. + * Copyright (C) 1997-2012 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 diff --git a/doc/autolink.doc b/doc/autolink.doc index 1f4b617..7dcb328 100644 --- a/doc/autolink.doc +++ b/doc/autolink.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2011 by Dimitri van Heesch. + * Copyright (C) 1997-2012 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 @@ -16,6 +16,8 @@ */ /*! \page autolink Automatic link generation + \tableofcontents + Most documentation systems have special `see also' sections where links to other pieces of documentation can be inserted. Although doxygen also has a command to start such a section (See section @@ -114,7 +116,7 @@ for the corresponding HTML documentation that is generated by Doxygen. \endhtmlonly - \section resolving typedefs. + \section resolving typedefs Typedefs that involve classes, structs and unions, like \verbatim diff --git a/doc/commands.doc b/doc/commands.doc index ad6b2ba..0b758e2 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2011 by Dimitri van Heesch. + * Copyright (C) 1997-2012 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 @@ -31,7 +31,7 @@ Each argument has a certain range: <li>If {curly} braces are used the argument extends until the next paragraph. Paragraphs are delimited by a blank line or by a section indicator. </ul> -If in addition to the aboveargument specifiers [square] brackets are used the argument is optional. +If in addition to the above argument specifiers [square] brackets are used the argument is optional. Here is an alphabetically sorted list of all commands with references to their documentation: @@ -166,6 +166,7 @@ documentation: \refitem cmdsubpage \\subpage \refitem cmdsubsection \\subsection \refitem cmdsubsubsection \\subsubsection +\refitem cmdtableofcontents \\tableofcontents \refitem cmdtest \\test \refitem cmdthrow \\throw \refitem cmdthrows \\throws @@ -192,6 +193,7 @@ documentation: \refitem cmdhash \\\# \refitem cmdperc \\\% \refitem cmdquot \\\" +\refitem cmdchardot \\\. \refitem cmddcolon \:: \endsecreflist @@ -387,7 +389,7 @@ Structural indicators \ref cfg_example_path "EXAMPLE_PATH" tag, you can include part of the absolute path to disambiguate it. - If more that one source file is needed for the example, + If more than one source file is needed for the example, the \\include command can be used. \par Example: @@ -494,7 +496,7 @@ Structural indicators the documentation is in front of the definition. The arguments of this command are the same as the second and third argument of \ref cmdclass "\\class". - The \<header-file\> name refers to the file that should by included by the + The \<header-file\> name refers to the file that should be included by the application to obtain the definition of the class, struct, or union. The \<header-name\> argument can be used to overwrite the name of the link that is used in the class documentation to something other @@ -535,7 +537,7 @@ Structural indicators By default the value of a define and the initializer of a variable are displayed unless they are longer than 30 lines. By putting this command in a comment block of a define or variable, the - initializer is always hidden. The maximum number of initalization linens + initializer is always hidden. The maximum number of initialization lines can be changed by means of the configuration parameter \ref cfg_max_initializer_lines "MAX_INITIALIZER_LINES", the default value is 30. @@ -922,7 +924,7 @@ Structural indicators are only displayed if they are less than 30 lines long. By putting this command in a comment block of a define or variable, the initializer is shown unconditionally. - The maximum number of initalization linens + The maximum number of initialization lines can be changed by means of the configuration parameter \ref cfg_max_initializer_lines "MAX_INITIALIZER_LINES", the default value is 30. @@ -945,7 +947,7 @@ Structural indicators \addindex \\typedef Indicates that a comment block contains documentation for a typedef (either global or as a member of a class). - This command is equivalent to \\var, \\propery, and \\fn. + This command is equivalent to \\var, \\property, and \\fn. \sa section \ref cmdfn "\\fn", \ref cmdproperty "\\property", and \ref cmdvar "\\var". @@ -966,7 +968,7 @@ Structural indicators \addindex \\var Indicates that a comment block contains documentation for a variable or enum value (either global or as a member of a class). - This command is equivalent to \\typedef, \\propery, and \\fn. + This command is equivalent to \\typedef, \\property, and \\fn. \sa section \ref cmdfn "\\fn", \ref cmdproperty "\\property", and \ref cmdtypedef "\\typedef". @@ -1159,7 +1161,7 @@ contains \c TEST, or \c DEV expected life span, etc. <hr> -\section cmddetails \\details { detailed decription } +\section cmddetails \\details { detailed description } \addindex \\details Just like \ref cmdbrief "\\brief" starts a brief description, \\details @@ -1385,6 +1387,18 @@ void memcpy(void *dest, const void *src, size_t n); sectioning command is encountered. See section \ref cmdfn "\\fn" for an example. + Note that you can also document multiple parameters with a single + \\param command using a comma separated list. Here is an example: + +\code +/** Sets the position. + * @param x,y,z Coordinates of the position in 3D space. + */ +void setPosition(double x,double y,double z,double t) +{ +} +\endcode + Note that for PHP one can also specify the type (or types if you separate them with a pipe symbol) which are allowed for a parameter (as this is not part of the definition). @@ -1763,6 +1777,17 @@ Make sure you have first read \ref intro "the introduction". \endverbatim <hr> +\section cmdtableofcontents \\tableofcontents + + \addindex \\tableofcontents + Creates a table of contents at the top of a page, listing all + sections and subsections in the page. + + \warning This command only works inside related page documentation and + \e not in other documentation blocks and only has effect in the + HTML output! + +<hr> \section cmdsection \\section <section-name> (section title) \addindex \\section @@ -2807,6 +2832,15 @@ class Receiver to indicate an unformatted text fragment. <hr> +\section cmdchardot \\. + + \addindex \\\. + This command writes a dot to the output. This can be useful to + prevent ending a brief description when JAVADOC_AUTOBRIEF is enabled + or to prevent starting a numbered list when the dot follows a number at + the start of a line. + +<hr> \section cmddcolon \\:: \addindex \\\:: diff --git a/doc/config.doc b/doc/config.doc index 9ec918b..c84b19f 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2011 by Dimitri van Heesch. + * Copyright (C) 1997-2012 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 @@ -16,6 +16,7 @@ */ /*! \page config Configuration +\tableofcontents \section config_format Format A configuration file is a free-form ASCII text file with a structure @@ -45,7 +46,7 @@ file using a <code>\@INCLUDE</code> tag as follows: The include file is searched in the current working directory. You can also specify a list of directories that should be searched before looking in the current working directory. Do this by putting a <code>\@INCLUDE_PATH</code> tag -with these paths before the <code>\@INCLUDE</code> tag, e.g: +with these paths before the <code>\@INCLUDE</code> tag, e.g.: \verbatim @INCLUDE_PATH = my_config_dir \endverbatim @@ -274,6 +275,7 @@ followed by the descriptions of the tags grouped by category. \refitem cfg_toc_expand TOC_EXPAND \refitem cfg_treeview_width TREEVIEW_WIDTH \refitem cfg_typedef_hides_struct TYPEDEF_HIDES_STRUCT +\refitem cfg_uml_limit_num_fields UML_LIMIT_NUM_FIELDS \refitem cfg_uml_look UML_LOOK \refitem cfg_use_htags USE_HTAGS \refitem cfg_use_inline_trees USE_INLINE_TREES @@ -1181,7 +1183,7 @@ AClass::ANamespace, ANamespace::*Test filter if there is a match. The filters are a list of the form: pattern=filter (like `*.cpp=my_cpp_filter`). See \c INPUT_FILTER for further info on how filters are used. If \c FILTER_PATTERNS is empty or if - non of the patterns match the file name, \c INPUT_FILTER is applied. + none of the patterns match the file name, \c INPUT_FILTER is applied. \anchor cfg_filter_source_files <dt>\c FILTER_SOURCE_FILES <dd> @@ -1808,8 +1810,9 @@ and Class Hierarchy pages using a tree view instead of an ordered list. (see http://www.mathjax.org) which uses client side Javascript for the rendering instead of using prerendered bitmaps. Use this if you do not have LaTeX installed or if you want to formulas look prettier in the HTML - output. When enabled you also need to install MathJax separately and - configure the path to it using the \ref cfg_mathjax_relpath "MATHJAX_RELPATH" option. + output. When enabled you may also need to install MathJax separately and + configure the path to it using the \ref cfg_mathjax_relpath "MATHJAX_RELPATH" + option. \anchor cfg_mathjax_relpath <dt>\c MATHJAX_RELPATH <dd> @@ -1819,9 +1822,9 @@ and Class Hierarchy pages using a tree view instead of an ordered list. directory should contain the MathJax.js script. For instance, if the mathjax directory is located at the same level as the HTML output directory, then \c MATHJAX_RELPATH should be <code>../mathjax</code>. The default value points to - the http://www.mathjax.org site, so you can quickly see the result without installing - MathJax, but it is strongly recommended to install a local copy of MathJax - before deployment. + the MathJax Content Delivery Network so you can quickly see the result without + installing MathJax. However, it is strongly recommended to install a local + copy of MathJax from http://www.mathjax.org before deployment. \anchor cfg_mathjax_extensions <dt>\c MATHJAX_EXTENSIONS <dd> @@ -2352,7 +2355,7 @@ The default size is 10pt. \addindex CLASS_GRAPH If the \c CLASS_GRAPH and \c 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 + indirect inheritance relations. Setting this tag to \c YES will force the \c CLASS_DIAGRAMS tag to NO. \anchor cfg_collaboration_graph @@ -2376,6 +2379,18 @@ The default size is 10pt. collaboration diagrams in a style similar to the OMG's Unified Modeling Language. +\anchor cfg_uml_limit_num_fields +<dt>\c UML_LIMIT_NUM_FIELDS <dd> + \addindex UML_LIMIT_NUM_FIELDS + If the \c 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 + managable. Set this to 0 for no limit. Note that the threshold may be + exceeded by 50% before the limit is enforced. So when you set the threshold + to 10, up to 15 fields may appear, but if the number exceeds 15, the + total amount of fields shown is limited to 10. + \anchor cfg_template_relations <dt>\c TEMPLATE_RELATIONS <dd> \addindex TEMPLATE_RELATIONS diff --git a/doc/custcmd.doc b/doc/custcmd.doc index 312a307..06ef0d1 100644 --- a/doc/custcmd.doc +++ b/doc/custcmd.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2011 by Dimitri van Heesch. + * Copyright (C) 1997-2012 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 @@ -16,6 +16,8 @@ */ /*! \page custcmd Custom Commands +\tableofcontents + Doxygen provides a large number of \ref commands "special commands", \ref xmlcmds "XML commands", and \ref htmlcmds "HTML commands". that can be used to enhance or structure the documentation inside a comment block. diff --git a/doc/customize.doc b/doc/customize.doc index d1be915..db376a8 100644 --- a/doc/customize.doc +++ b/doc/customize.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2011 by Dimitri van Heesch. + * Copyright (C) 1997-2012 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 @@ -16,6 +16,8 @@ */ /*! \page customize Customizing the output +\tableofcontents + 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. @@ -84,7 +86,7 @@ that are disabled by default: 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 th size of the images exceeds a certain size). + happens when the size of the images exceeds a certain size). \subsection minor_tweaks_header_css Header, Footer, and Stylesheet changes @@ -92,7 +94,7 @@ 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="http://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 comform to the style +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: @@ -121,13 +123,17 @@ 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 is 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, 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. + \section layout Changing the layout of pages In some cases you may want to change the way the output is structured. diff --git a/doc/diagrams.doc b/doc/diagrams.doc index 0f5c607..7d488fa 100644 --- a/doc/diagrams.doc +++ b/doc/diagrams.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2011 by Dimitri van Heesch. + * Copyright (C) 1997-2012 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 diff --git a/doc/docblocks.doc b/doc/docblocks.doc index 093122b..facd1b5 100644 --- a/doc/docblocks.doc +++ b/doc/docblocks.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2011 by Dimitri van Heesch. + * Copyright (C) 1997-2012 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 @@ -15,6 +15,7 @@ * */ /*! \page docblocks Documenting the code +\tableofcontents This chapter covers two topics: 1. How to put comments in your code such that doxygen incorporates them in @@ -504,7 +505,7 @@ lower then sign). The brief documentation also ends at a line not starting with a \c # (hash sign). Inside doxygen comment blocks all normal doxygen markings are supported. -The only expections are described in the following two paragraphs. +The only exceptions are described in the following two paragraphs. If a doxygen comment block ends with a line containing only \c #\\code or \c #\@code all code until a line only containing \c #\\endcode @@ -560,7 +561,7 @@ Go to the <a href="lists.html">next</a> section or return to the \section docstructure Anatomy of a comment block -The previous section focussed on how to make the comments in your code known +The previous section focused on how to make the comments in your code known to doxygen, it explained the difference between a brief and a detailed description, and the use of structural commands. diff --git a/doc/doxygen.1 b/doc/doxygen.1 index deb0c20..45090f4 100644 --- a/doc/doxygen.1 +++ b/doc/doxygen.1 @@ -41,6 +41,6 @@ doxygen \fB\-e\fR rtf extensionsFile If \fB\-s\fR is specified the comments in the config file will be omitted. If configName is omitted `Doxyfile' will be used as a default. .SH AUTHOR -Doxygen version VERSION, Copyright Dimitri van Heesch 1997-2011 +Doxygen version VERSION, Copyright Dimitri van Heesch 1997-2012 .SH SEE ALSO doxywizard(1). diff --git a/doc/doxygen_manual.css b/doc/doxygen_manual.css index 8dfe6dd..1f22b59 100644 --- a/doc/doxygen_manual.css +++ b/doc/doxygen_manual.css @@ -822,7 +822,7 @@ dl padding: 0 0 0 10px; } -dl.note, dl.warning, dl.attention, dl.pre, dl.post, dl.invariant, dl.deprecated, dl.todo, dl.test, dl.bug +dl.section { border-left:4px solid; padding: 0 0 0 6px; @@ -863,6 +863,10 @@ dl.bug border-color: #C08050; } +dl.section dd { + margin-bottom: 1em; +} + #projectlogo { text-align: center; @@ -946,6 +950,54 @@ dl.citelist dd { padding:5px 0; } +div.toc { + padding: 14px 25px; + background-color: #F6F6F6; + border: 1px solid #DDDDDD; + border-radius: 7px 7px 7px 7px; + float: right; + height: auto; + margin: 0 20px 10px 10px; + width: 200px; +} + +div.toc li { + background: url("bdwn.png") no-repeat scroll 0 5px transparent; + font: 10px/1.2 Verdana,DejaVu Sans,Geneva,sans-serif; + margin-top: 5px; + padding-left: 10px; + padding-top: 2px; +} + +div.toc h3 { + font: bold 12px/1.2 Arial,FreeSans,sans-serif; + border-bottom: 0 none; + color: #606060; + margin: 0; +} + +div.toc ul { + list-style: none outside none; + border: medium none; + padding: 0px; +} + +div.toc li.level1 { + margin-left: 0px; +} + +div.toc li.level2 { + margin-left: 15px; +} + +div.toc li.level3 { + margin-left: 30px; +} + +div.toc li.level4 { + margin-left: 45px; +} + @media print { #top { display: none; } diff --git a/doc/doxygen_manual.tex b/doc/doxygen_manual.tex index 54898e8..8e47015 100644 --- a/doc/doxygen_manual.tex +++ b/doc/doxygen_manual.tex @@ -12,7 +12,8 @@ % Documents produced by Doxygen are derivative works derived from the % input used in their production; they are not affected by this license. -\documentclass[a4paper]{book} +\documentclass{book} +\usepackage[a4paper,left=2.5cm,right=2.5cm,top=2.5cm,bottom=2.5cm]{geometry} \usepackage{makeidx} \usepackage{natbib} \usepackage{graphicx} diff --git a/doc/doxygen_usage.doc b/doc/doxygen_usage.doc index 0cffb3d..40e5163 100644 --- a/doc/doxygen_usage.doc +++ b/doc/doxygen_usage.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2011 by Dimitri van Heesch. + * Copyright (C) 1997-2012 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 diff --git a/doc/doxywizard_usage.doc b/doc/doxywizard_usage.doc index de24add..435661b 100644 --- a/doc/doxywizard_usage.doc +++ b/doc/doxywizard_usage.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2011 by Dimitri van Heesch. + * Copyright (C) 1997-2012 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 @@ -28,7 +28,7 @@ The first step is to choose one of the ways to configure doxygen. <dl> <dt>Wizard<dd>Click this button to quickly configure the most important settings and leave the rest of the options to their defaults. -<dt>Expert<dd>Click this button to to gain access to the +<dt>Expert<dd>Click this button to gain access to the \ref config "full range of configuration options". <dt>Load<dd>Click this button to load an existing configuration file from disk. diff --git a/doc/external.doc b/doc/external.doc index 2a6426e..013b7c2 100644 --- a/doc/external.doc +++ b/doc/external.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2011 by Dimitri van Heesch. + * Copyright (C) 1997-2012 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 diff --git a/doc/faq.doc b/doc/faq.doc index 7547d16..0475aa7 100644 --- a/doc/faq.doc +++ b/doc/faq.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2011 by Dimitri van Heesch. + * Copyright (C) 1997-2012 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 diff --git a/doc/features.doc b/doc/features.doc index 688a1b1..46a6219 100644 --- a/doc/features.doc +++ b/doc/features.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2011 by Dimitri van Heesch. + * Copyright (C) 1997-2012 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 @@ -63,7 +63,7 @@ the Qt specific signal and slots sections. Extraction of private class members is optional. <li>Automatically generates references to documented classes, files, namespaces - and members. Documentation of global functions, globals variables, + and members. Documentation of global functions, global variables, typedefs, defines and enumerations is also supported. <li>References to base/super classes and inherited/overridden members are generated automatically. diff --git a/doc/formulas.doc b/doc/formulas.doc index 9f049eb..bc23a11 100644 --- a/doc/formulas.doc +++ b/doc/formulas.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2011 by Dimitri van Heesch. + * Copyright (C) 1997-2012 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 diff --git a/doc/grouping.doc b/doc/grouping.doc index 825a289..56f19f7 100644 --- a/doc/grouping.doc +++ b/doc/grouping.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2011 by Dimitri van Heesch. + * Copyright (C) 1997-2012 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 diff --git a/doc/htmlcmds.doc b/doc/htmlcmds.doc index aa03498..7b3ff71 100644 --- a/doc/htmlcmds.doc +++ b/doc/htmlcmds.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2011 by Dimitri van Heesch. + * Copyright (C) 1997-2012 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 @@ -123,7 +123,7 @@ The special HTML character entities that are recognized by Doxygen: <li><tt>\’</tt> right single quotation mark <li><tt>\“</tt> left double quotation mark <li><tt>\”</tt> right double quotation mark -<li><tt>\–</tt> n-dash (for numeric ranges, eg. 2–8) +<li><tt>\–</tt> n-dash (for numeric ranges, e.g. 2–8) <li><tt>\—</tt> m-dash (for parenthetical punctuation — like this) <li><tt>\&?uml;</tt> where ? is one of {A,E,I,O,U,Y,a,e,i,o,u,y}, writes a character with a diaeresis accent (like ä). diff --git a/doc/index.doc b/doc/index.doc index 48f01e6..e604ee5 100644 --- a/doc/index.doc +++ b/doc/index.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2011 by Dimitri van Heesch. + * Copyright (C) 1997-2012 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 @@ -113,7 +113,7 @@ The third part provides information for developers: \addindex license \addindex GPL -Copyright © 1997-2011 by +Copyright © 1997-2012 by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>.<p> Permission to use, copy, modify, and distribute this software and its diff --git a/doc/install.doc b/doc/install.doc index 6a18784..d076cf3 100644 --- a/doc/install.doc +++ b/doc/install.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2011 by Dimitri van Heesch. + * Copyright (C) 1997-2012 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 @@ -17,21 +17,13 @@ /*! \page install Installation \addindex installation +\tableofcontents + First go to the <a href="http://www.doxygen.org/download.html">download</a> page -to get the latest distribution, if you did not have it already. - -This section is divided into the following sections: -<ul> -<li>\ref install_src_unix "Compiling from source on UNIX" -<li>\ref install_bin_unix "Installing the binaries on UNIX" -<li>\ref unix_problems "Known compilation problems for UNIX" -<li>\ref install_src_windows "Compiling from source on Windows" -<li>\ref install_bin_windows "Installing the binaries on Windows" -<li>\ref build_tools "Tools used to develop doxygen" -</ul> +to get the latest distribution, if you did not downloaded doxygen already. -\section install_src_unix Compiling from source on UNIX +\section install_src_unix Compiling from source on UNIX If you downloaded the source distribution, you need at least the following to build the executable: @@ -357,7 +349,7 @@ Now you need to add/adjust the following environment variables - add <code>c:\\tools\\unxutils\\usr\\local\\wbin;</code> to the start of <code>PATH</code> - set <code>BISON_SIMPLE</code> to <code>c:\\tools\\unxutils\\usr\\local\\share\\bison.simple</code> -Download doxygen's source tarball and put it somewhere (e.g use <code>c:\\tools</code>) +Download doxygen's source tarball and put it somewhere (e.g. use <code>c:\\tools</code>) Now start a new command shell and type \verbatim @@ -371,7 +363,7 @@ Now your environment is setup to build \c doxygen. Inside the \c doxygen-x.y.z directory you will find a \c winbuild directory containing a \c Doxygen.sln file. Open this file in Visual Studio. -You can now build the Release or Debug flavor of Doxygen and Doxytag by right-clicking +You can now build the Release or Debug flavor of Doxygen by right-clicking the project in the solutions explorer, and selecting Build. Note that compiling Doxywizard currently requires Qt version 4 diff --git a/doc/language.doc b/doc/language.doc index a155d48..7fa38e4 100644 --- a/doc/language.doc +++ b/doc/language.doc @@ -23,7 +23,7 @@ text fragments, generated by doxygen, can be produced in languages other than English (the default). The output language is chosen through the configuration file (with default name and known as Doxyfile). -Currently (version 1.7.5), 39 languages +Currently (version 1.7.6.1), 39 languages are supported (sorted alphabetically): Afrikaans, Arabic, Armenian, Brazilian Portuguese, Catalan, Chinese, Chinese Traditional, Croatian, Czech, Danish, Dutch, English, diff --git a/doc/markdown.doc b/doc/markdown.doc index ea6776e..07378ef 100644 --- a/doc/markdown.doc +++ b/doc/markdown.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2011 by Dimitri van Heesch. + * Copyright (C) 1997-2012 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 @@ -16,34 +16,7 @@ */ /*! \page markdown Markdown support -Table of contents -- \ref markdown_std - - \ref md_para - - \ref md_headers - - \ref md_blockquotes - - \ref md_lists - - \ref md_codeblock - - \ref md_rulers - - \ref md_emphasis - - \ref md_codespan - - \ref md_links - - \ref md_inlinelinks - - \ref md_reflinks - - \ref md_images - - \ref md_autolink -- \ref markdown_extra - - \ref md_tables - - \ref md_fenced - - \ref md_header_id -- \ref markdown_dox - - \ref md_page_header - - \ref md_html_blocks - - \ref mddox_code_blocks - - \ref mddox_code_spans - - \ref mddox_lists - - \ref mddox_stars - - \ref mddox_limits -- \ref markdown_debug +[TOC] [Markdown] support was introduced in doxygen version 1.8.0. It is a plain text formatting @@ -57,7 +30,7 @@ syntax written by John Gruber, with the following underlying design goal: > text-to-HTML filters, the single biggest source of inspiration > for Markdown’s syntax is the format of plain text email. -In the \ref markdown_std "next section" the standard markdown features +In the \ref markdown_std "next section" the standard Markdown features are briefly discussed. The reader is referred to the [Markdown site][markdown] for more details. @@ -128,7 +101,7 @@ to avoid false positives, i.e. when writing 0 if OK\n >1 if NOK -the second line will not seen as a block quote. +the second line will not be seen as a block quote. \subsection md_lists Lists @@ -315,13 +288,21 @@ Note that doxygen will also produce the links without the angle brackets. \section markdown_extra Markdown Extensions +\subsection md_toc Table of Contents + +Doxygen supports a special link marker `[TOC]` which can be placed in a page +to produce a table of contents at the start of the page, listing all sections. + +Note that using `[TOC]` is the same as using a +\ref cmdtableofcontents "\\tableofcontents" command. + \subsection md_tables Tables Of the features defined by "Markdown Extra" is support for <a href="http://michelf.com/projects/php-markdown/extra/#table">simple tables</a>: A table consists of a header line, a separator line, and at least one -row line. Table columns are separated by the pipe (!) character. +row line. Table columns are separated by the pipe (|) character. Here is an example: @@ -360,7 +341,7 @@ fenced code blocks</a>: A fenced code block does not require indentation, and is defined by a pair of "fence lines". Such a line consists of 3 or -more tile (~) characters on a line. The end of the block should have the +more tilde (~) characters on a line. The end of the block should have the same number of tildes. Here is an example: @@ -370,12 +351,13 @@ same number of tildes. Here is an example: a one-line code block ~~~~~~~~~~~~~~~~~~~~~ -The contents of the code block is syntax highlighted. -The default language is based on the file it was found in -(i.e. a fenced block in a Python file is assumed to be Python code). -In case the language is not clear from the context or you want to -indicate a specific language you can add the language's extension after -the opening fence: +By default the output is the same as for a normal code block. + +For languages supported by doxygen you can also make the code block +appear with syntax highlighting. To do so you need to +indicate the typical file extension that corresponds to the +programming language after the opening fence. For highlighting according +to the Python language for instance, you would need to write the following: ~~~~~~~~~~~~~{.py} # A class @@ -383,26 +365,26 @@ the opening fence: pass ~~~~~~~~~~~~~ -will produce: +which will produce: ~~~~~~~~~~~~~{.py} # A class class Dummy: pass ~~~~~~~~~~~~~ -and +and for C you would write: ~~~~~~~~~~~~~~~{.c} int func(int a,int b) { return a*b; } ~~~~~~~~~~~~~~~ -will produce: +which will produce: ~~~~~~~~~~~~~~~{.c} int func(int a,int b) { return a*b; } ~~~~~~~~~~~~~~~ -The curly brances and dot are optional by the way. +The curly braces and dot are optional by the way. \subsection md_header_id Header Id Attributes @@ -429,7 +411,7 @@ Note this only works for the headers of level 1 to 4. \section markdown_dox Doxygen specifics -Even doxygen tries to following the Markdown standard as closely as +Even though doxygen tries to following the Markdown standard as closely as possible, there are couple of deviation and doxygen specifics additions. \subsection md_page_header Including Markdown files as pages @@ -479,7 +461,7 @@ and in other sections that need to be processed without changes \subsection mddox_code_blocks Code Block Indentation -With markdown any block that is indented by 4 spaces (and 8 spaces +With Markdown any block that is indented by 4 spaces (and 8 spaces inside lists) is treated as a code block. This indentation amount is absolute, i.e. counting from the start of the line. @@ -580,13 +562,13 @@ To avoid that a stray * or _ matches something many paragraphs later, and shows everything in between with emphasis, doxygen limits the scope of a * and _ to a single paragraph. -For code span, between the starting and ending backtick only two +For a code span, between the starting and ending backtick only two new lines are allowed. Also for links there are limits; the link text, and link title each can contain only one new line, the URL may not contain any newlines. -\section markdown_debug Debugging problems +\section markdown_debug Debugging of problems When doxygen parses the source code it first extracts the comments blocks, then passes these through the Markdown preprocessor. The output of the diff --git a/doc/output.doc b/doc/output.doc index f2c742c..d34e057 100644 --- a/doc/output.doc +++ b/doc/output.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2011 by Dimitri van Heesch. + * Copyright (C) 1997-2012 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 diff --git a/doc/preprocessing.doc b/doc/preprocessing.doc index 603c683..49dd0f1 100644 --- a/doc/preprocessing.doc +++ b/doc/preprocessing.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2011 by Dimitri van Heesch. + * Copyright (C) 1997-2012 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 @@ -47,7 +47,7 @@ Then by default doxygen will feed the following to its parser: You can disable all preprocessing by setting \ref cfg_enable_preprocessing "ENABLE_PREPROCESSING" to \c NO in the configuration file. In the case above doxygen will then read -both statements, i.e: +both statements, i.e.: \verbatim static CONST_STRING version = "2.xx"; diff --git a/doc/searching.doc b/doc/searching.doc index dc0dd9e..b3e4fd9 100644 --- a/doc/searching.doc +++ b/doc/searching.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2011 by Dimitri van Heesch. + * Copyright (C) 1997-2012 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 @@ -139,7 +139,7 @@ has its own advantages and disadvantages: To enable the help plugin set \ref cfg_generate_eclipsehelp "GENERATE_ECLIPSEHELP" to \c YES, and define a unique identifier for your project via - \ref cfg_eclipse_doc_id "ECLIPSE_DOC_ID", i.e: + \ref cfg_eclipse_doc_id "ECLIPSE_DOC_ID", i.e.: \verbatim GENERATE_ECLIPSEHELP = YES ECLIPSE_DOC_ID = com.yourcompany.yourproject diff --git a/doc/starting.doc b/doc/starting.doc index a60093f..4e5481e 100644 --- a/doc/starting.doc +++ b/doc/starting.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2011 by Dimitri van Heesch. + * Copyright (C) 1997-2012 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 @@ -15,6 +15,7 @@ * */ /*! \page starting Getting started +\tableofcontents The executable \c doxygen is the main program that parses the sources and generates the documentation. See section \ref doxygen_usage for more @@ -196,7 +197,8 @@ The generated \f$\mbox{\LaTeX}\f$ documentation must first be compiled by a \f$\mbox{\LaTeX}\f$ compiler (I use a recent teTeX distribution for Linux and MacOSX and MikTex for Windows). To simplify the process of compiling the generated -documentation, \c doxygen writes a \c Makefile into the \c latex directory. +documentation, \c doxygen writes a \c Makefile into the \c latex directory +(on the Windows platform also a \c make.bat batch file is generated). The contents and targets in the \c Makefile depend on the setting of \ref cfg_use_pdflatex "USE_PDFLATEX". If it is disabled (set to \c NO), then diff --git a/doc/translator_report.txt b/doc/translator_report.txt index f53d003..382c066 100644 --- a/doc/translator_report.txt +++ b/doc/translator_report.txt @@ -1,4 +1,4 @@ -(1.7.5) +(1.7.6.1) Doxygen supports the following 39 languages (sorted alphabetically): @@ -112,6 +112,7 @@ for occurence of the method identifiers: QCString trAlphabeticalList() QCString trDCOPMethods() QCString trDirDependency(const char *) + QCString trFuncProtos() QCString trFunctionPrototypeDocumentation() QCString trGraphicalHierarchy() QCString trSearchForIndex() diff --git a/doc/trouble.doc b/doc/trouble.doc index 4fb41d2..c795b0f 100644 --- a/doc/trouble.doc +++ b/doc/trouble.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2011 by Dimitri van Heesch. + * Copyright (C) 1997-2012 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 @@ -31,7 +31,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. diff --git a/doc/xmlcmds.doc b/doc/xmlcmds.doc index 5116209..526fce7 100644 --- a/doc/xmlcmds.doc +++ b/doc/xmlcmds.doc @@ -2,7 +2,7 @@ * * * - * Copyright (C) 1997-2011 by Dimitri van Heesch. + * Copyright (C) 1997-2012 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 |