diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/autolink.doc | 2 | ||||
| -rw-r--r-- | doc/commands.doc | 158 | ||||
| -rw-r--r-- | doc/config.doc | 41 | ||||
| -rw-r--r-- | doc/features.doc | 23 | ||||
| -rw-r--r-- | doc/history.doc | 25 | ||||
| -rw-r--r-- | doc/index.doc | 24 | ||||
| -rw-r--r-- | doc/install.doc | 3 | ||||
| -rw-r--r-- | doc/starting.doc | 17 |
8 files changed, 149 insertions, 144 deletions
diff --git a/doc/autolink.doc b/doc/autolink.doc index 2f0e04c..352e905 100644 --- a/doc/autolink.doc +++ b/doc/autolink.doc @@ -61,7 +61,7 @@ \par Note 1: The patterns above should not contain spaces, tabs or newlines. \par Note 2: - For JavaDoc compatibility a \c # may be used instead of a \c :: in + For JavaDoc compatibility a \# may be used instead of a :: in the patterns above. For non overloaded members the argument list may be omitted. diff --git a/doc/commands.doc b/doc/commands.doc index 1efd378..bbe5a9c 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -18,7 +18,9 @@ \section commands Special Commands All commands in the documentation start with a backslash (<b>\\</b>) or an -at-sign (<b>\@</b>). +at-sign (<b>\@</b>). If you prefer you can replace all commands starting with a +backslash below, by their counterparts that start with an at-sign. + Some commands have one or more arguments. Each argument has a certain range: <ul> @@ -41,67 +43,68 @@ documentation: \begin{CompactList} \endlatexonly <li> \refitem cmda \a -<li> \refitem cmdaddindex \addindex +<li> \refitem cmdaddindex \addindex <li> \refitem cmdanchor \anchor <li> \refitem cmdarg \arg -<li> \refitem cmdauthor \author +<li> \refitem cmdauthor \author <li> \refitem cmdb \b -<li> \refitem cmdbrief \brief -<li> \refitem cmdbug \bug +<li> \refitem cmdbrief \brief +<li> \refitem cmdbug \bug <li> \refitem cmdc \c -<li> \refitem cmdclass \class +<li> \refitem cmdclass \class <li> \refitem cmdcode \code -<li> \refitem cmddate \date -<li> \refitem cmddef \def -<li> \refitem cmddefgroup \defgroup -<li> \refitem cmddontinclude \dontinclude +<li> \refitem cmddate \date +<li> \refitem cmddef \def +<li> \refitem cmddefgroup \defgroup +<li> \refitem cmddeprecated \deprecated +<li> \refitem cmddontinclude \dontinclude <li> \refitem cmde \e <li> \refitem cmdendcode \endcode <li> \refitem cmdendhtmlonly \endhtmlonly <li> \refitem cmdendlatexonly \endlatexonly <li> \refitem cmdendlink \endlink <li> \refitem cmdendverbatim \endverbatim -<li> \refitem cmdenum \enum -<li> \refitem cmdexample \example -<li> \refitem cmdexception \exception +<li> \refitem cmdenum \enum +<li> \refitem cmdexample \example +<li> \refitem cmdexception \exception <li> \refitem cmdfdollar \f$ <li> \refitem cmdfbropen \f[ <li> \refitem cmdfbrclose \f] -<li> \refitem cmdfile \file -<li> \refitem cmdfn \fn +<li> \refitem cmdfile \file +<li> \refitem cmdfn \fn <li> \refitem cmdhtmlonly \htmlonly -<li> \refitem cmdimage \image -<li> \refitem cmdinclude \include -<li> \refitem cmdingroup \ingroup +<li> \refitem cmdimage \image +<li> \refitem cmdinclude \include +<li> \refitem cmdingroup \ingroup <li> \refitem cmdinternal \internal <li> \refitem cmdlatexonly \latexonly -<li> \refitem cmdline \line -<li> \refitem cmdlink \link -<li> \refitem cmdmainpage \mainpage +<li> \refitem cmdline \line +<li> \refitem cmdlink \link +<li> \refitem cmdmainpage \mainpage <li> \refitem cmdnamespace \namespace -<li> \refitem cmdoverload \overload -<li> \refitem cmdpage \page -<li> \refitem cmdpar \par -<li> \refitem cmdparam \param -<li> \refitem cmdref \ref -<li> \refitem cmdrelates \relates -<li> \refitem cmdreturn \return +<li> \refitem cmdoverload \overload +<li> \refitem cmdpage \page +<li> \refitem cmdpar \par +<li> \refitem cmdparam \param +<li> \refitem cmdref \ref +<li> \refitem cmdrelates \relates +<li> \refitem cmdreturn \return <li> \refitem cmdretval \retval -<li> \refitem cmdsa \sa -<li> \refitem cmdsection \section -<li> \refitem cmdskip \skip -<li> \refitem cmdskipline \skipline -<li> \refitem cmdstruct \struct -<li> \refitem cmdsubsection \subsection +<li> \refitem cmdsa \sa +<li> \refitem cmdsection \section +<li> \refitem cmdskip \skip +<li> \refitem cmdskipline \skipline +<li> \refitem cmdstruct \struct +<li> \refitem cmdsubsection \subsection <li> \refitem cmdthrow \throw <li> \refitem cmdtypedef \typedef -<li> \refitem cmdunion \union +<li> \refitem cmdunion \union <li> \refitem cmduntil \until -<li> \refitem cmdvar \var +<li> \refitem cmdvar \var <li> \refitem cmdverbatim \verbatim <li> \refitem cmdverbinclude \verbinclude -<li> \refitem cmdversion \version -<li> \refitem cmdwarning \warning +<li> \refitem cmdversion \version +<li> \refitem cmdwarning \warning <li> \refitem cmddollar \$ <li> \refitem cmdat \@ <li> \refitem cmdbackslash \\ @@ -147,7 +150,7 @@ Doxygen. Unrecognized commands are treated as normal text. <hr> \subsection cmdcode \code - \addindex \\code + \addindex \code Starts a block of code. A code block is treated differently from ordinary text. It is interpreted as C/C++ code. The names of the classes and members that are documented are automatically replaced by @@ -489,8 +492,6 @@ Doxygen. Unrecognized commands are treated as normal text. for the corresponding HTML documentation that is generated by Doxygen. \endhtmlonly - \sa Section \ref cmdjdauthor "@author". - <hr> \subsection cmdbrief \brief {brief description} @@ -504,9 +505,9 @@ Doxygen. Unrecognized commands are treated as normal text. blank line or another sectioning command is encountered. If multiple \\brief commands are present they will be joined. See section \ref cmdauthor "\\author" for an example. - - \sa Section \ref cmdjdshort "@short". + Synonymous to \\short. + <hr> \subsection cmdbug \bug { bug description } @@ -537,7 +538,13 @@ Doxygen. Unrecognized commands are treated as normal text. sectioning command is encountered. See section \ref cmdauthor "\\author" for an example. - \sa Section \ref cmdjddate "@date". +<hr> +\subsection cmddeprecated \deprecated { description } + + \addindex \deprecated + Starts a paragraph indicating that this documentation block belongs to + a deprecated entity. Can be used to describe alternatives, + expected life span, etc. <hr> \subsection cmdpar \par (paragraph title) { paragraph } @@ -573,8 +580,6 @@ Doxygen. Unrecognized commands are treated as normal text. sectioning command is encountered. See section \ref cmdfn "\\fn" for an example. - \sa Section \ref cmdjdparam "@param". - <hr> \subsection cmdexception \exception <exception-object> { exception description } @@ -593,13 +598,11 @@ Doxygen. Unrecognized commands are treated as normal text. \par Note: the tag \\exceptions is a synonym for this tag. - \sa Section \ref cmdjdexception "@exception". - <hr> \subsection cmdthrow \throw <exception-object> { exception description } \addindex \throw - Equivalent to \\exception (see section \ref cmdexception "\\exception"). + Synonymous to \\exception (see section \ref cmdexception "\\exception"). \par Note: the tag \\throws is a synonym for this tag. @@ -616,9 +619,6 @@ Doxygen. Unrecognized commands are treated as normal text. sectioning command is encountered. See section \ref cmdfn "\\fn" for an example. - \sa Section \ref cmdjdreturn "@return". - - <hr> \subsection cmdretval \retval <return value> { description } @@ -633,8 +633,6 @@ Doxygen. Unrecognized commands are treated as normal text. The \\retval description ends when a blank line or some other sectioning command is encountered. - \sa Section \ref cmdjdretval "@retval". - <hr> \subsection cmdsa \sa { references } @@ -646,8 +644,10 @@ Doxygen. Unrecognized commands are treated as normal text. may be selected by including a parenthesized list of argument types after the method. - \sa section \ref autolink "\\autolink" for information on how to create links to objects - and section \ref cmdjdsee "@see" for the JavaDoc version of this command. + Synonymous to \\see. + + \sa section \ref autolink "\\autolink" for information on how to create links + to objects. <hr> \subsection cmdversion \version { version number } @@ -664,8 +664,6 @@ Doxygen. Unrecognized commands are treated as normal text. sectioning command is encountered. See section \ref cmdauthor "\\author" for an example. - \sa Section \ref cmdjdversion "@version". - <hr> \subsection cmdwarning \warning { warning message } @@ -1024,7 +1022,7 @@ Doxygen. Unrecognized commands are treated as normal text. <hr> \subsection cmdfdollar \f$ - \addindex \\f$ + \addindex \f$ Marks the start and end of an in-text formula. \sa section \ref formulas "formulas" for an example. @@ -1032,7 +1030,7 @@ Doxygen. Unrecognized commands are treated as normal text. <hr> \subsection cmdfbropen \f[ - \addindex \\f[ + \addindex \f[ Marks the start of a long formula that is displayed centered on a separate line. @@ -1041,7 +1039,7 @@ Doxygen. Unrecognized commands are treated as normal text. <hr> \subsection cmdfbrclose \f] - \addindex \\f] + \addindex \f] Marks the end of a long formula that is displayed centered on a separate line. @@ -1205,44 +1203,6 @@ Doxygen. Unrecognized commands are treated as normal text. <hr> <h2>\htmlonly <center> --- \endhtmlonly - Commands included for JavaDoc compatibility - \htmlonly --- </center>\endhtmlonly</h2> - -The following command JavaDoc command are support. - -\subsection cmdjdauthor @author { list of authors } - \addindex @author - Equivalent to \\author (see section \ref cmdauthor "\\author"). -\subsection cmdjddate @date { date description } - \addindex @date - Equivalent to \\date (see section \ref cmddate "\\date"). -\subsection cmdjdparam @param <parameter-name> { parameter-description } - \addindex @param - Equivalent to \\param (see section \ref cmdparam "\\param"). -\subsection cmdjdexception @exception <exception-object> { exception-description } - \addindex @exception - Equivalent to \\exception (see section \ref cmdexception "\\exception"). - Also synonymous to \@exceptions and \\exceptions. -\subsection cmdjdthrows @throw <exception-object> { exception-description } - Equivalent to \\throw (see section \ref cmdthrow "\\throw"). - Also synonymous to \@exception and \\exception. -\subsection cmdjdreturn @return { description of the return value } - \addindex @return - Equivalent to \\return (see section \ref cmdreturn "\\return"). -\subsection cmdjdretval @retval <return value name> { return value description } - \addindex @retval - Equivalent to \\retval (see section \ref cmdretval "\\retval"). -\subsection cmdjdsee @see { references } - \addindex @see - Equivalent to \\sa (see section \ref cmdsa "\\sa"). -\subsection cmdjdshort @short { brief description } - \addindex @short - Equivalent to \\brief (see section \ref cmdbrief "\\brief"). -\subsection cmdjdversion @version { version number } - \addindex @version - Equivalent to \\version (see section \ref cmdversion "\\version"). - -<h2>\htmlonly <center> --- \endhtmlonly Commands included for Qt compatibility \htmlonly --- </center>\endhtmlonly</h2> diff --git a/doc/config.doc b/doc/config.doc index 80089a4..eaa37e6 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -303,7 +303,7 @@ followed by the descriptions of the tags grouped by category. \anchor cfg_javadoc_autobrief <dt>\c JAVADOC_AUTOBRIEF <dd> \addindex JAVADOC_AUTOBRIEF - If the \c JAVADOC_NO_AUTOBRIEF is set to \c YES (the default) then Doxygen + If the \c JAVADOC_AUTOBRIEF is set to \c YES (the default) then Doxygen will interpret the first line (until the first dot) of a JavaDoc-style comment as the brief description. If set to NO, the Javadoc-style will behave just like the Qt-style comments. @@ -444,10 +444,12 @@ followed by the descriptions of the tags grouped by category. The following commands have a special meaning inside the header: <code>\$title</code>, <code>\$datetime</code>, <code>\$date</code>, - <code>\$doxygenversion</code>. + <code>\$doxygenversion</code>, <code>\$projectname</code>, + <code>\$projectnumber</code>. Doxygen will replace them by respectively the title of the page, the current date and time, only the current date, - or the version number of doxygen. + the version number of doxygen, the project name (see PROJECT_NAME), or the + project number (see PROJECT_NUMBER). \anchor cfg_html_footer <dt>\c HTML_FOOTER <dd> @@ -461,10 +463,15 @@ followed by the descriptions of the tags grouped by category. \endverbatim If the tag is left blank doxygen will generate a standard footer. - The following commands have a special meaning inside the footer: - <code>\$title</code>, <code>\$datetime</code>, <code>\$date</code>. + The following commands have a special meaning inside the header: + <code>\$title</code>, <code>\$datetime</code>, <code>\$date</code>, + <code>\$doxygenversion</code>, <code>\$projectname</code>, + <code>\$projectnumber</code>. Doxygen will replace them by respectively - the title of the page, the current date and time, or only the current date. + the title of the page, the current date and time, only the current date, + the version number of doxygen, the project name (see PROJECT_NAME), or the + project number (see PROJECT_NUMBER). + \anchor cfg_html_stylesheet <dt>\c HTML_STYLESHEET <dd> @@ -477,14 +484,19 @@ followed by the descriptions of the tags grouped by category. \verbatim H1 { text-align: center } +A.qindex {} +A.qindexRef {} A.el { text-decoration: none; font-weight: bold } +A.elRef { font-weight: bold } +A.code { text-decoration: none; font-weight: normal; color: #4444ee } +A.codeRef { font-weight: normal; color: #4444ee } +A.gl:link { color: #ffffff } +A.gl:visited { color: #ffffff } +A.gl { text-decoration: none; font-weight: bold; background-color: #ff8080 } DL.el { margin-left: -1cm } DIV.fragment { width: 100%; border: none; background-color: #eeeeee } DIV.in { margin-left: 16 } DIV.ah { background-color: black; margin-bottom: 3; margin-top: 3 } -A.gl:link { color: #ffffff } -A.gl:visited { color: #ffffff } -A.gl { text-decoration: none; font-weight: bold; background-color: #ff8080 } TD.md { background-color: #f2f2ff } \endverbatim @@ -622,6 +634,15 @@ EXTRA_PACKAGES = times \par Note: Only use a user defined header if you know what you are doing! + The following commands have a special meaning inside the header: + <code>\$title</code>, <code>\$datetime</code>, <code>\$date</code>, + <code>\$doxygenversion</code>, <code>\$projectname</code>, + <code>\$projectnumber</code>. + 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 PROJECT_NAME), or the + project number (see PROJECT_NUMBER). + </dl> \subsection man_output Man page related options @@ -842,7 +863,7 @@ DOC_ABSPATH = /home/dimitri/.html/qdbttabular BIN_ABSPATH = /home/dimitri/bin \endverbatim -To regenerate the Qt documentation from the sources, you could use the +To regenerate the Qt-1.44 documentation from the sources, you could use the following config file: \verbatim PROJECT_NAME = Qt diff --git a/doc/features.doc b/doc/features.doc index aa3a33a..4381bc7 100644 --- a/doc/features.doc +++ b/doc/features.doc @@ -22,6 +22,15 @@ <li>Requires very little overhead from the writer of the documentation. Plain text will do, but for more fancy or structured output HTML tags and/or some of doxygen's special commands can be used. +<li>Supports C++, (Corba or Microsoft) IDL and C sources. +<li>Supports documentation of files, namespaces, classes, structs, unions, + templates, variables, functions, typedefs, enums and defines. +<li>JavaDoc (1.1), Qt-Doc, and KDOC compatible. +<li>Automatically generates class diagrams in HTML (as clickable + image maps) and \f$\mbox{\LaTeX}\f$ (as encapsulated postscript images). +<li>Allows you to put documentation in the header file (before the + declaration of an entity), source file (before the definition of an entity) + or in a separate file. <li>Outputs documentation in on-line format (HTML and UNIX man page) and off-line format (\f$\mbox{\LaTeX}\f$) simultaniously (any one can be disabled if desired). Both formats are optimized for @@ -29,23 +38,18 @@ Furthermore, compressed HTML can be generated from HTML output using Microsoft's HTML help workshop (Windows only) and PDF can be generated from the \f$\mbox{\LaTeX}\f$ output. -<li>Allows documentation of files, namespaces, classes, structs, unions, - templates, variables, functions, typedefs, enums and defines. <li>Includes a full C preprocessor to allow proper parsing of conditional - code fragments and to allow expansion of all or part of the define macros. + code fragments and to allow expansion of all or part of macros definitions. <li>Automatically detects public, protected and private sections, as well as the Qt specific signal and slots sections. Extraction of private class members is optional. -<li>Automatically generates of class diagrams in HTML (as clickable - image maps) and \f$\mbox{\LaTeX}\f$ (as encapsulated postscript images). -<li>JavaDoc (1.1) and Qt-Doc compatible. +<li>Automatically generates references to documented classes, files, namespaces + and members. Documentation of global functions, globals variables, + typedefs, defines and enumerations is also supported. <li>References to base/super classes and inherited/overridden members are generated automatically. <li>Includes a fast, rank based search engine to search for strings or words in the class and member documentation. -<li>Automatic generation of references to documented classes, files and - members. Documentation of global functions, globals variables, - typedefs, defines and enumerations is also supported. <li>Documentation may be placed either at the declaration or at the definition of a member function or class. Most documentation systems (such as Javadoc) only support the former, others (such as Qt) only the latter. @@ -61,6 +65,7 @@ looking into the implementation details. <li>Allows automatic cross-referencing of (documented) entities with their definition in the source code. +<li>Allows inclusion of function/member/class definitions in the documentation. <li>All options are read from an easy to edit and documented configuration file. <li>Documentation and search engine can be transferred to another diff --git a/doc/history.doc b/doc/history.doc index dce7d93..d724966 100644 --- a/doc/history.doc +++ b/doc/history.doc @@ -16,18 +16,21 @@ /*! \page history Doxygen History -<h3>Features scheduled for version 1.0</h3> +<h3>Version 1.0.0</h3> + +<h4>New features:</h4> <ul> - <li>Include LaTeX style formulas in LaTeX and HTML output (in HTML as a gif). - <li>Multi-lingual support: currently supported languages are: English, - Dutch, French, German, Italian, Swedish, Czech, Japanese. - <li>Generation of class diagrams (clickable image maps in HTML, eps images - in postscript). - <li>Output generator for the man page format. - <li>Proper support for template classes, members, functions and specializations. - <li>Proper support for namespaces. - <li>Reintroduction of the multi-column class list (and file list) to quickly - select a class or file +<li>Support for templates and namespaces. +<li>Internationalization support. Currently supported languages are: + English, Czech, German, Spanish, Finnish, French, Italian, Japanse, + Dutch, and Swedish. +<li>Automatic generation of inheritance diagrams for sub & super classes. +<li>Support for man page, compressed HTML help, and hyperlinked PDF output. +<li>Cross-referencing documentation with source code and source inlining. +<li>LaTeX formulas can be included in the documentation. +<li>Support for parsing Corba & Microsoft IDL. +<li>Images can be included in the documentation. +<li>Improved parsing & preprocessing. </ul> <h3>Version 0.4</h3> diff --git a/doc/index.doc b/doc/index.doc index 640129b..ae16306 100644 --- a/doc/index.doc +++ b/doc/index.doc @@ -41,15 +41,15 @@ for more details. All output generated by Doxygen is not covered by this license. <h2>Introduction</h2> -Doxygen is a documentation system for C and C++. It can generate an on-line -class browser (in HTML) and/or an off-line reference manual +Doxygen is a documentation system for C, C++ and IDL. It can generate an +on-line class browser (in HTML) and/or an off-line reference manual (in \f$\mbox{\LaTeX}\f$) from a set of documented source files. There is also support for generating man pages and for converting the generated output into Postscript, hyperlinked PDF or compressed HTML. The documentation is extracted directly from the -sources. Doxygen is developed on a <a href="http://www.linux.org">Linux</a> -platform, but it runs on most other UNIX flavors as well. +sources. Doxygen is developed on <a href="http://www.linux.org">Linux</a>, +but it runs on most other UNIX flavors as well. An executable for Windows 9x/NT is also available. Doxygen can also be configured to extract the code-structure from undocumented @@ -127,15 +127,19 @@ of possible and/or requested enhancements. Thanks go to: <ul> \addindex Doc++ -<li>Malte Zöckler and Roland Wunderling, authors of Doc++. - The first version of Doxygen was based on an old version of Doc++. - Although I have rewritten practically all code since then, Doc++ has still +<li>Malte Zöckler and Roland Wunderling, authors of DOC++. + The first version of Doxygen borrowed some code of an old version of DOC++. + Although I have rewritten practically all code since then, DOC++ has still given me a good start in writing Doxygen. -<li>All people at Troll Tech, for creating a beautiful GUI Toolkit. +<li>All people at Troll Tech, for creating a beautiful GUI Toolkit (which is even useful for GUI-less applications like doxygen :-) <li>My brother <a href="http://www.stack.nl/~fidget/index.html">Frank</a> for rendering the logos. <li>Harm van der Heijden for adding HTML help support. +<li>Jens Breitenstein, Christophe Bordeaux, Samuel Hägglund, Xet Erixon, + Vlastimil Havran, Ahmed Also Faisal, Alessandro Falappa, Kenji Nagamatsu, + Francisco Oltra Thennet, Olli Korhonen for providing translations into + various languages. <li> Arnt Gulbrandsen, Adam P. Jenkins, @@ -201,6 +205,10 @@ Jacques Tremblay, John Sturton, Moshe Kruger, David Wong, +Peter Garner, +Fred Labrosse, +Frank Schimmel, +Reinhard Nissl and many others for suggestions, patches and bug reports. </ul> */ diff --git a/doc/install.doc b/doc/install.doc index 1c5171a..78ae4f8 100644 --- a/doc/install.doc +++ b/doc/install.doc @@ -57,7 +57,7 @@ To override the auto detected platform you can specify \verbatim configure --platform platform-type \endverbatim -See the \c PLATFORMS file for a list of possible platforms. +See the file \c PLATFORMS for a list of possible platforms. For more configuration options use <code>configure --help</code> To compile and link the sources enter @@ -102,6 +102,7 @@ Doxygen was developed and tested under Linux using the following tools: <li>Netscape 4.61 <li>Troll Tech's tmake version 1.3 (included in the distribution) <li>teTeX version 0.9 +<li>CVS 1.10.7 </ul> \htmlonly diff --git a/doc/starting.doc b/doc/starting.doc index 4f707c7..a1fe89b 100644 --- a/doc/starting.doc +++ b/doc/starting.doc @@ -99,7 +99,7 @@ the output directory. As the names suggest the \c html directory contains the generated documentation in HTML format and the \c latex directory contains the generated documentation in \f$\mbox{\LaTeX}\f$ format. Man pages are put -in a man3 directory inside the \c man directory. +in a \c man3 directory inside the \c man directory. The default output directory is the directory in which \c doxygen is started. The directory to which the output is written can be changed @@ -123,11 +123,11 @@ By typing \c make in the \c latex directory the dvi file \c refman.dvi will be generated (provided that you have a make tool called <code>make</code> ofcourse). This file can then be viewed using \c xdvi or converted into a postscript file \c refman.ps by typing <code>make ps</code> -(this requires \c dvips ). The Postscript file can be send to a postscript +(this requires <code>dvips</code>). The Postscript file can be send to a postscript printer. If you do not have a postscript printer, you can try to use ghostscript to convert postscript into something your printer understands. Conversion to PDF is also possible; just type -<code>make pdf</code>. +<code>make pdf</code> (this required <code>ps2pdf</code>). To get the best results for PDF output you should set the \c PDF_HYPERLINKS tag to \c YES. @@ -208,6 +208,13 @@ The following types of special documentation blocks are supported by doxygen: \endverbatim </ul> +Doxygen only allows one brief and one detailed description. If there is +one brief description before a declaration and one before a +definition, only the one before the \e declaration will be used. If +the same situation occurs for a detail description, +the one before the \e definition is preferred and the one before the +declaration will be ignored. + Here is an example of a documented piece of C++ code using the Qt style: \verbinclude qtstyle.cpp \htmlonly @@ -551,9 +558,9 @@ after the \c INPUT_FILTER tag. \subsection moreinfo More information \addindex QdbtTabular -For a more elaborate example see <a href="http://www.stack.nl/~dimitri/qdbttabular/html/index.html"> +For a more elaborate example see <a href="http://www.stack.nl/~dimitri/qdbttabular/doc/html/index.html"> the documentation of QdbtTabular</a> \latexonly -({\tt http://www.stack.nl/$\sim$dimitri/qdbttabular/html})\endlatexonly. +({\tt http://www.stack.nl/$\sim$dimitri/qdbttabular/doc/html})\endlatexonly. \htmlonly I hope that was clear. If not, please let me know, so I can improve this document. If you have problems take a look at the <a href="faq.html">faq</a> and the <a href="trouble.html">troubleshooting</a> sections. |