diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/doxygen_manual.tex | 2 | ||||
| -rw-r--r-- | doc/grouping.doc | 16 | ||||
| -rw-r--r-- | doc/install.doc | 10 |
3 files changed, 20 insertions, 8 deletions
diff --git a/doc/doxygen_manual.tex b/doc/doxygen_manual.tex index 833540e..c86184a 100644 --- a/doc/doxygen_manual.tex +++ b/doc/doxygen_manual.tex @@ -15,7 +15,7 @@ \documentclass[a4paper,ps2pdf]{article} \usepackage{a4wide} \usepackage{makeidx} -\usepackage{fancyheadings} +\usepackage{fancyhdr} \usepackage{epsf} \usepackage{doxygen} \usepackage{multicol} diff --git a/doc/grouping.doc b/doc/grouping.doc index 2f1bef7..a09cda0 100644 --- a/doc/grouping.doc +++ b/doc/grouping.doc @@ -33,7 +33,21 @@ To define a group, you should put the \ref cmddefgroup "\\defgroup" command in a special comment block. The first argument of the command is a label that should uniquely identify the group. You can make an entity a member of a specific group by putting -a \ref cmdingroup "\\ingroup" command inside its documentation. +a \ref cmdingroup "\\ingroup" command inside its documentation block. + +To avoid putting \ref cmdingroup "\\ingroup" commands in the documentation +of each member you can also group members together by the +open marker <code>\@{</code> before the group and the +closing marker <code>\@}</code> after the group. The markers can +be put in the documentation of the group definition or in a separate +documentation block. + +Groups can also be nested using these grouping markers. + +Note that compound entities (like classes, files and namespaces) can +be put into multiple groups, but members (like variable, functions, typedefs +and enums) can only be a member of one group +(this restriction is to avoid ambiguous linking targets). \par Example: \verbinclude group.cpp diff --git a/doc/install.doc b/doc/install.doc index 1a065a2..8a2ac19 100644 --- a/doc/install.doc +++ b/doc/install.doc @@ -462,19 +462,17 @@ Compilation is now done by performing the following steps: nmake \endverbatim -<li>To generate the doxygen documentation, do ensure, that the - <code>html</code> and <code>latex</code> subdirectories exist. - Then go to the <code>doc</code> subdirectory and type: +<li>To generate the doxygen documentation, go to the <code>doc</code> + subdirectory and type: \verbatim - doxygen nmake \endverbatim - The generated docs int HTML are located in the <code>html</code> + The generated docs int HTML are located in the <code>..\html</code> subdirectory. - The sources for LaTeX documentation are located in <code>latex</code> + The sources for LaTeX documentation are located in <code>..\latex</code> subdirectory. From those sources, the DVI, PostScript, and PDF documentation can be generated. </ol> |