diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/arch.doc | 4 | ||||
| -rw-r--r-- | doc/autolink.doc | 2 | ||||
| -rw-r--r-- | doc/commands.doc | 10 | ||||
| -rw-r--r-- | doc/faq.doc | 8 | ||||
| -rw-r--r-- | doc/htmlcmds.doc | 134 | ||||
| -rw-r--r-- | doc/install.doc | 5 | ||||
| -rw-r--r-- | doc/language.doc | 16 |
7 files changed, 94 insertions, 85 deletions
diff --git a/doc/arch.doc b/doc/arch.doc index 1851d31..71b9ff5 100644 --- a/doc/arch.doc +++ b/doc/arch.doc @@ -58,7 +58,7 @@ of macros. This is to allow macro names to appear in the type of function parameters for instance. Another difference is that the preprocessor parses, but not actually includes -code when it encounters a #include (with the exception of #include +code when it encounters a \#include (with the exception of \#include found inside { ... } blocks). The reasons behind this deviation from the standard is to prevent feeding multiple definitions of the same functions/classes to doxygen's parser. If all source files would @@ -67,7 +67,7 @@ definitions (and their documentation) would be present in each translation unit. The preprocessor is written using \c flex and can be found in -\c src/pre.l. For condition blocks (#if) evaluation of constant expressions +\c src/pre.l. For condition blocks (\#if) evaluation of constant expressions is needed. For this a \c yacc based parser is used, which can be found in \c src/constexp.y and \c src/constexp.l. diff --git a/doc/autolink.doc b/doc/autolink.doc index c7f9ba7..3bb0e9a 100644 --- a/doc/autolink.doc +++ b/doc/autolink.doc @@ -62,7 +62,7 @@ <li><tt>(\<className\>"::")<sup>n</sup>\<functionName\>"()"</tt> <li><tt>(\<className\>"::")<sup>n</sup>\<functionName\></tt> </ol> - where n>0. + where n\>0. \par Note 1: The patterns above should not contain spaces, tabs or newlines. diff --git a/doc/commands.doc b/doc/commands.doc index 0a6a352..33456bb 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -90,6 +90,7 @@ documentation: \refitem cmdline \\line \refitem cmdlink \\link \refitem cmdmainpage \\mainpage +\refitem cmdn \\n \refitem cmdname \\name \refitem cmdnamespace \\namespace \refitem cmdnosubgrouping \\nosubgrouping @@ -205,7 +206,7 @@ doxygen. Unrecognized commands are treated as normal text. \addindex \\def Indicates that a comment block contains documentation for a - \c #define macro. + \c \#define macro. \par Example: \verbinclude define.h @@ -1627,6 +1628,13 @@ ALIASES = "english=\if english" \ Equivalent to \ref cmdarg "\\arg" <hr> +\section cmdn \n + + \addindex \\n + Forces a new line. Equivalent to \<br\> and inspired by + the printf function. + +<hr> \section cmdp \p <word> \addindex \\p diff --git a/doc/faq.doc b/doc/faq.doc index 98199eb..4f7ce54 100644 --- a/doc/faq.doc +++ b/doc/faq.doc @@ -104,7 +104,7 @@ You can document your class like To make doxygen put <br><br> <code> -#include \<path/include.h\> +\#include \<path/include.h\> </code> in the documentation of the class MyClassName regardless of the name of the actual @@ -192,15 +192,15 @@ remove the % and keep the word unlinked. This error happens when doxygen lexical scanner has a rules that matches more than 16K input character in one go. I've seen this happening -on a very large generated file (>16K lines), where the built-in preprocessor -converted it into an empty file (with >16K of newlines). Another case +on a very large generated file (\>16K lines), where the built-in preprocessor +converted it into an empty file (with \>16K of newlines). Another case where this might happen is if you have lines in your code with more than 16K characters. If you have ran into such a case and want me to fix it, you should send me a code fragment that triggers the message. -<li><b>How did doxygen get it's name?</b> +<li><b>How did doxygen get its name?</b> Doxygen got its name from playing with the words documentation and generator. diff --git a/doc/htmlcmds.doc b/doc/htmlcmds.doc index 7f79852..96b22f5 100644 --- a/doc/htmlcmds.doc +++ b/doc/htmlcmds.doc @@ -23,73 +23,73 @@ documentation. Note that all attributes of a HTML tag are ignored <ul> <li><tt>\<A HREF="..."\></tt> Starts a HTML hyper-link (HTML only). <li><tt>\<A NAME="..."\></tt> Starts an named anchor (HTML only). -<li><tt>\</A></tt> Ends a link or anchor (HTML only). -<li><tt>\<B></tt> Starts a piece of text displayed in a bold font. -<li><tt>\</B></tt> Ends a <tt>\<B\></tt> section. -<li><tt>\<BODY></tt> Does not generate any output. -<li><tt>\</BODY></tt> Does not generate any output. -<li><tt>\<BR></tt> Forces a line break. -<li><tt>\<CENTER></tt> starts a section of centered text. -<li><tt>\</CENTER></tt> ends a section of centered text. -<li><tt>\<CAPTION></tt> Starts a caption. Use within a table only. -<li><tt>\</CAPTION></tt> Ends a caption. Use within a table only. -<li><tt>\<CODE></tt> Starts a piece of text displayed in a typewriter font. -<li><tt>\</CODE></tt> End a <tt>\<CODE\></tt> section. -<li><tt>\<DD></tt> Starts an item description. -<li><tt>\<DFN></tt> Starts a piece of text displayed in a typewriter font. -<li><tt>\</DFN></tt> Ends a <tt>\<DFN\></tt> section. -<li><tt>\<DL></tt> Starts a description list. -<li><tt>\</DL></tt> Ends a description list. -<li><tt>\<DT></tt> Starts an item title. -<li><tt>\</DT></tt> Ends an item title. -<li><tt>\<EM></tt> Starts a piece of text displayed in an italic font. -<li><tt>\</EM></tt> Ends a <tt>\<EM\></tt> section. -<li><tt>\<FORM></tt> Does not generate any output. -<li><tt>\</FORM></tt> Does not generate any output. -<li><tt>\<HR></tt> Writes a horizontal ruler. -<li><tt>\<H1></tt> Starts an unnumbered section. -<li><tt>\</H1></tt> Ends an unnumberd section. -<li><tt>\<H2></tt> Starts an unnumbered subsection. -<li><tt>\</H2></tt> Ends an unnumbered subsection. -<li><tt>\<H3></tt> Starts an unnumbered subsubsection. -<li><tt>\</H3></tt> Ends an unnumbered subsubsection. -<li><tt>\<I></tt> Starts a piece of text displayed in an italic font. -<li><tt>\<INPUT></tt> Does not generate any output. -<li><tt>\</I></tt> Ends a <tt>\<I\></tt> section. -<li><tt>\<IMG></tt> This command is written with attributes to the HTML output only. -<li><tt>\<LI></tt> Starts a new list item. -<li><tt>\</LI></tt> Ends a list item. -<li><tt>\<META></tt> Does not generate any output. -<li><tt>\<MULTICOL></tt> ignored by doxygen. -<li><tt>\</MUTLICOL></tt> ignored by doxygen. -<li><tt>\<OL></tt> Starts a numbered item list. -<li><tt>\</OL></tt> Ends a numbered item list. -<li><tt>\<P></tt> Starts a new paragraph. -<li><tt>\</P></tt> Ends a paragraph. -<li><tt>\<PRE></tt> Starts a preformatted fragment. -<li><tt>\</PRE></tt> Ends a preformatted fragment. -<li><tt>\<SMALL></tt> Starts a section of text displayed in a smaller font. -<li><tt>\</SMALL></tt> Ends a <tt>\<SMALL\></tt> section. -<li><tt>\<STRONG></tt> Starts a section of bold text. -<li><tt>\</STRONG></tt> Ends a section of bold text. -<li><tt>\<SUB></tt> Starts a piece of text displayed in subscript. -<li><tt>\</SUB></tt> Ends a <tt>\<SUB\></tt> section. -<li><tt>\<SUP></tt> Starts a piece of text displayed in superscript. -<li><tt>\</SUP></tt> Ends a <tt>\</SUP\></tt> section. -<li><tt>\<TABLE></tt> starts a table. -<li><tt>\</TABLE></tt> ends a table. -<li><tt>\<TD></tt> Starts a new table data element. -<li><tt>\</TD></tt> Ends a table data element. -<li><tt>\<TR></tt> Starts a new table row. -<li><tt>\</TR></tt> Ends a table row. -<li><tt>\<TT></tt> Starts a piece of text displayed in a typewriter font. -<li><tt>\</TT></tt> Ends a <tt>\<TT\></tt> section. -<li><tt>\<KBD></tt> Starts a piece of text displayed in a typewriter font. -<li><tt>\</KBD></tt> Ends a <tt>\<KBD\></tt> section. -<li><tt>\<UL></tt> Starts an unnumbered item list. -<li><tt>\</UL></tt> Ends an unnumbered item list. -<li><tt>\<VAR></tt> Starts a piece of text displayed in an italic font. -<li><tt>\</VAR></tt> Ends a <tt>\</VAR\></tt> section. +<li><tt>\</A\></tt> Ends a link or anchor (HTML only). +<li><tt>\<B\></tt> Starts a piece of text displayed in a bold font. +<li><tt>\</B\></tt> Ends a <tt>\<B\></tt> section. +<li><tt>\<BODY\></tt> Does not generate any output. +<li><tt>\</BODY\></tt> Does not generate any output. +<li><tt>\<BR\></tt> Forces a line break. +<li><tt>\<CENTER\></tt> starts a section of centered text. +<li><tt>\</CENTER\></tt> ends a section of centered text. +<li><tt>\<CAPTION\></tt> Starts a caption. Use within a table only. +<li><tt>\</CAPTION\></tt> Ends a caption. Use within a table only. +<li><tt>\<CODE\></tt> Starts a piece of text displayed in a typewriter font. +<li><tt>\</CODE\></tt> End a <tt>\<CODE\></tt> section. +<li><tt>\<DD\></tt> Starts an item description. +<li><tt>\<DFN\></tt> Starts a piece of text displayed in a typewriter font. +<li><tt>\</DFN\></tt> Ends a <tt>\<DFN\></tt> section. +<li><tt>\<DL\></tt> Starts a description list. +<li><tt>\</DL\></tt> Ends a description list. +<li><tt>\<DT\></tt> Starts an item title. +<li><tt>\</DT\></tt> Ends an item title. +<li><tt>\<EM\></tt> Starts a piece of text displayed in an italic font. +<li><tt>\</EM\></tt> Ends a <tt>\<EM\></tt> section. +<li><tt>\<FORM\></tt> Does not generate any output. +<li><tt>\</FORM\></tt> Does not generate any output. +<li><tt>\<HR\></tt> Writes a horizontal ruler. +<li><tt>\<H1\></tt> Starts an unnumbered section. +<li><tt>\</H1\></tt> Ends an unnumberd section. +<li><tt>\<H2\></tt> Starts an unnumbered subsection. +<li><tt>\</H2\></tt> Ends an unnumbered subsection. +<li><tt>\<H3\></tt> Starts an unnumbered subsubsection. +<li><tt>\</H3\></tt> Ends an unnumbered subsubsection. +<li><tt>\<I\></tt> Starts a piece of text displayed in an italic font. +<li><tt>\<INPUT\></tt> Does not generate any output. +<li><tt>\</I\></tt> Ends a <tt>\<I\></tt> section. +<li><tt>\<IMG\></tt> This command is written with attributes to the HTML output only. +<li><tt>\<LI\></tt> Starts a new list item. +<li><tt>\</LI\></tt> Ends a list item. +<li><tt>\<META\></tt> Does not generate any output. +<li><tt>\<MULTICOL\></tt> ignored by doxygen. +<li><tt>\</MUTLICOL\></tt> ignored by doxygen. +<li><tt>\<OL\></tt> Starts a numbered item list. +<li><tt>\</OL\></tt> Ends a numbered item list. +<li><tt>\<P\></tt> Starts a new paragraph. +<li><tt>\</P\></tt> Ends a paragraph. +<li><tt>\<PRE\></tt> Starts a preformatted fragment. +<li><tt>\</PRE\></tt> Ends a preformatted fragment. +<li><tt>\<SMALL\></tt> Starts a section of text displayed in a smaller font. +<li><tt>\</SMALL\></tt> Ends a <tt>\<SMALL\></tt> section. +<li><tt>\<STRONG\></tt> Starts a section of bold text. +<li><tt>\</STRONG\></tt> Ends a section of bold text. +<li><tt>\<SUB\></tt> Starts a piece of text displayed in subscript. +<li><tt>\</SUB\></tt> Ends a <tt>\<SUB\></tt> section. +<li><tt>\<SUP\></tt> Starts a piece of text displayed in superscript. +<li><tt>\</SUP\></tt> Ends a <tt>\</SUP\></tt> section. +<li><tt>\<TABLE\></tt> starts a table. +<li><tt>\</TABLE\></tt> ends a table. +<li><tt>\<TD\></tt> Starts a new table data element. +<li><tt>\</TD\></tt> Ends a table data element. +<li><tt>\<TR\></tt> Starts a new table row. +<li><tt>\</TR\></tt> Ends a table row. +<li><tt>\<TT\></tt> Starts a piece of text displayed in a typewriter font. +<li><tt>\</TT\></tt> Ends a <tt>\<TT\></tt> section. +<li><tt>\<KBD\></tt> Starts a piece of text displayed in a typewriter font. +<li><tt>\</KBD\></tt> Ends a <tt>\<KBD\></tt> section. +<li><tt>\<UL\></tt> Starts an unnumbered item list. +<li><tt>\</UL\></tt> Ends an unnumbered item list. +<li><tt>\<VAR\></tt> Starts a piece of text displayed in an italic font. +<li><tt>\</VAR\></tt> Ends a <tt>\</VAR\></tt> section. </ul> The special HTML character entities that are recognized by Doxygen: diff --git a/doc/install.doc b/doc/install.doc index 96a1056..fe7fd55 100644 --- a/doc/install.doc +++ b/doc/install.doc @@ -181,8 +181,9 @@ Compilation is now done by performing the following steps: directory manually to some <code>bin</code> directory in your search path. This is sufficient to use doxygen. - \note You need the GNU install tool for this to work. Other - install tools may put the binaries in the wrong directory! + \note You need the GNU install tool for this to work (it is part of + the fileutils package). Other install tools may put the binaries in + the wrong directory! If you have a RPM or DEP package, then please follow the standard installation procedure that is required for these packages. diff --git a/doc/language.doc b/doc/language.doc index 42b1195..f850044 100644 --- a/doc/language.doc +++ b/doc/language.doc @@ -25,7 +25,7 @@ Doxygen has built-in support for multiple languages. This means that the text fragments that doxygen generates can be produced in languages other than English (the default) at configuration time. -Currently (version 1.2.14-20020317), 27 languages +Currently (version 1.2.17-20020804), 27 languages are supported (sorted alphabetically): Brazilian Portuguese, Chinese, Chinese Traditional, Croatian, Czech, Danish, Dutch, English, Finnish, French, @@ -133,7 +133,7 @@ when the translator was updated. <TD>Italian</TD> <TD>Alessandro Falappa<br>Ahmed Aldo Faisal</TD> <TD>alessandro@NOSPAM.falappa.net<br>aaf23@NOSPAM.cam.ac.uk</TD> - <TD>1.2.17</TD> + <TD>up-to-date</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>Japanese</TD> @@ -175,7 +175,7 @@ when the translator was updated. <TD>Russian</TD> <TD>Alexandr Chelpanov</TD> <TD>cav@NOSPAM.cryptopro.ru</TD> - <TD>1.2.17</TD> + <TD>up-to-date</TD> </TR> <TR BGCOLOR="#ffffff"> <TD>Serbian</TD> @@ -252,7 +252,7 @@ when the translator was updated. \hline Hungarian & F\"{o}ldv\'{a}ri Gy\"{o}rgy & {\tt foldvari@diatronltd.com} & 1.2.1 \\ \hline - Italian & Alessandro Falappa & {\tt alessandro@falappa.net} & 1.2.17 \\ + Italian & Alessandro Falappa & {\tt alessandro@falappa.net} & up-to-date \\ & Ahmed Aldo Faisal & {\tt aaf23@cam.ac.uk} & \\ \hline Japanese & Ryunosuke Sato & {\tt puyo@mint.freemail.ne.jp} & 1.2.17 \\ @@ -269,7 +269,7 @@ when the translator was updated. \hline Romanian & Alexandru Iosup & {\tt aiosup@yahoo.com} & 1.2.16 \\ \hline - Russian & Alexandr Chelpanov & {\tt cav@cryptopro.ru} & 1.2.17 \\ + Russian & Alexandr Chelpanov & {\tt cav@cryptopro.ru} & up-to-date \\ \hline Serbian & Dejan Milosavljevic & {\tt dmilos@email.com} & 1.2.16 \\ \hline @@ -315,8 +315,8 @@ Just follow these steps: defines which language translators will be compiled into doxygen executable. It is a kind of configuration file. If you are sure that you do not need some of the languages, you can remove (comment out) - definitions of symbols for the languages, or you can say \c #undef - instead of \c #define for them. + definitions of symbols for the languages, or you can say \c \#undef + instead of \c \#define for them. <li>Edit language.cpp: Add a \verbatim @@ -346,7 +346,7 @@ Just follow these steps: <li>Edit <code>translator_xx.h</code>: <ul> <li>Rename <code>TRANSLATOR_EN_H</code> to <code>TRANSLATOR_XX_H</code> - twice (i.e. in the \c #ifndef and \c #define preprocessor commands at + twice (i.e. in the \c \#ifndef and \c \#define preprocessor commands at the beginning of the file). <li>Rename TranslatorEnglish to TranslatorYourLanguage <li>In the member <code>idLanguage()</code> change "english" into the |