diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/commands.doc | 30 | ||||
| -rw-r--r-- | doc/customize.doc | 2 | ||||
| -rw-r--r-- | doc/docblocks.doc | 6 | ||||
| -rw-r--r-- | doc/doxygen_manual.tex | 1 | ||||
| -rw-r--r-- | doc/doxygen_usage.doc | 2 | ||||
| -rw-r--r-- | doc/htmlcmds.doc | 4 | ||||
| -rw-r--r-- | doc/install.doc | 14 | ||||
| -rw-r--r-- | doc/markdown.doc | 12 | ||||
| -rw-r--r-- | doc/searching.doc | 2 | ||||
| -rw-r--r-- | doc/trouble.doc | 2 |
10 files changed, 39 insertions, 36 deletions
diff --git a/doc/commands.doc b/doc/commands.doc index 15d6827..7644f69 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -290,7 +290,7 @@ Structural indicators \addindex \\category For Objective-C only: Indicates that a comment block contains documentation for a class category with name \<name\>. The arguments are - equal to the \\class command. + equal to the \ref cmdclass "\\class" command. \sa section \ref cmdclass "\\class". @@ -929,7 +929,7 @@ Structural indicators <hr> \section cmdrelated \\related <name> - \addindex related + \addindex \\related Equivalent to \ref cmdrelates "\\relates" <hr> @@ -946,7 +946,7 @@ Structural indicators <hr> \section cmdrelatedalso \\relatedalso <name> - \addindex relatedalso + \addindex \\relatedalso Equivalent to \ref cmdrelatesalso "\\relatesalso" <hr> @@ -1496,13 +1496,13 @@ void setPosition(double x,double y,double z,double t) * Rest of the comment block continues. */ \endverbatim - Note that the \\parblock command may also appear directly after - \\param's first argument. + Note that the \c \\parblock command may also appear directly after + \ref cmdparam "\\param"'s first argument. <hr> \section cmdendparblock \\endparblock \addindex \\endparblock - This ends a block of paragraphs started with \\ref cmdparblock "\\parblock". + This ends a block of paragraphs started with \ref cmdparblock "\\parblock". <hr> \section cmdtparam \\tparam <template-parameter-name> { description } @@ -1612,7 +1612,7 @@ void setPosition(double x,double y,double z,double t) may be selected by including a parenthesized list of argument types after the method name. - Synonymous to \\see. + Synonymous to \ref cmdsee "\\see". \sa section \ref autolink "autolink" for information on how to create links to objects. @@ -1633,7 +1633,7 @@ void setPosition(double x,double y,double z,double t) \section cmdsince \\since { text } \addindex \\since - This tag can be used to specify since when (version or time) an + This command can be used to specify since when (version or time) an entity is available. The paragraph that follows \c \\since does not have any special internal structure. All visual enhancement commands may be used inside the paragraph. The \c \\since description ends when a blank @@ -1656,7 +1656,7 @@ void setPosition(double x,double y,double z,double t) Synonymous \ref cmdexception "\\exception". \par Note: - the tag \c \\throws is a synonym for this tag. + the command \ref cmdthrows "\\throws" is a synonym for this command. \sa section \ref cmdexception "\\exception" @@ -2060,7 +2060,7 @@ Commands for displaying examples \ref cmddontinclude "\\dontinclude" command in combination with the \ref cmdline "\\line", \ref cmdskip "\\skip", \ref cmdskipline "\\skipline", - and \\until commands. + and \ref cmduntil "\\until" commands. Alternatively, the \ref cmdsnippet "\\snippet" command can be used to include only a fragment of a source file. For this to work the @@ -2392,12 +2392,14 @@ Commands for visual enhancements <hr> \section cmdcopybrief \\copybrief <link-object> + \addindex \\copybrief Works in a similar way as \ref cmdcopydoc "\\copydoc" but will only copy the brief description, not the detailed documentation. <hr> \section cmdcopydetails \\copydetails <link-object> + \addindex \\copydetails Works in a similar way as \ref cmdcopydoc "\\copydoc" but will only copy the detailed documentation, not the brief description. @@ -2424,7 +2426,7 @@ only copy the detailed documentation, not the brief description. Doxygen will pass the text on to dot and include the resulting image (and image map) into the output. The nodes of a graph can be made clickable by using the URL attribute. - By using the command \\ref inside the URL value you can conveniently + By using the command \ref cmdref "\\ref" inside the URL value you can conveniently link to an item inside doxygen. Here is an example: \code /*! class B */ @@ -2475,12 +2477,12 @@ Here is an example of the use of the \c \\msc command. class Sender { public: - /** Acknowledgement from server */ + /** Acknowledgment from server */ void Ack(bool ok); }; /** Receiver class. Can be used to receive and execute commands. - * After execution of a command, the receiver will send an acknowledgement + * After execution of a command, the receiver will send an acknowledgment * \msc * Receiver,Sender; * Receiver<-Sender [label="Command()", URL="\ref Command()"]; @@ -2981,7 +2983,7 @@ class Receiver \section cmdamp \\\& \addindex \\\& - This command writes the \c \& character to output. + This command writes the \c \& character to the output. This character has to be escaped because it has a special meaning in HTML. <hr> diff --git a/doc/customize.doc b/doc/customize.doc index 6e321bd..b1ef58d 100644 --- a/doc/customize.doc +++ b/doc/customize.doc @@ -389,7 +389,7 @@ 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 -a 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://sphinx.pocoo.org/">Sphinx</a> document generator. diff --git a/doc/docblocks.doc b/doc/docblocks.doc index 1b96361..b86ed89 100644 --- a/doc/docblocks.doc +++ b/doc/docblocks.doc @@ -461,7 +461,7 @@ When using doxygen for Fortran code you should set \ref cfg_optimize_for_fortran "OPTIMIZE_FOR_FORTRAN" to \c YES. For Fortran "!>" or "!<" starts a comment and "!!" or "!>" can be used to -continuate a one line comment into a multi-line comment. +continue an one line comment into a multi-line comment. Here is an example of a documented Fortran subroutine: \verbatim @@ -476,7 +476,7 @@ Here is an example of a documented Fortran subroutine: Type(SpMtx), intent(out) :: Restrict !< Our restriction matrix \endverbatim -As a alternative you can also use comments in fixed format code: +As an alternative you can also use comments in fixed format code: \verbatim C> Function comment @@ -541,7 +541,7 @@ commands without the leading namespace use p.e.: \verbatim TCL_SUBST = class itcl:class body itcl:body \endverbatim --> -Following is a example using doxygen style comments: +Following is an example using doxygen style comments: \include tclexample.tcl \htmlonly diff --git a/doc/doxygen_manual.tex b/doc/doxygen_manual.tex index f62f017..58615ed 100644 --- a/doc/doxygen_manual.tex +++ b/doc/doxygen_manual.tex @@ -51,6 +51,7 @@ \usepackage[titles]{tocloft} \usepackage{amssymb} \usepackage{doxygen} +\newcommand{\+}{\discretionary{\mbox{\scriptsize$\hookleftarrow$}}{}{}} \lstset{language=C++,inputencoding=utf8,basicstyle=\footnotesize,breaklines=true,breakatwhitespace=true,tabsize=8,numbers=left } \makeindex \setcounter{tocdepth}{3} diff --git a/doc/doxygen_usage.doc b/doc/doxygen_usage.doc index ddad5d7..b7fdc40 100644 --- a/doc/doxygen_usage.doc +++ b/doc/doxygen_usage.doc @@ -17,7 +17,7 @@ /*! \page doxygen_usage Doxygen usage Doxygen is a command line based utility. Calling \c doxygen with the -\c --help option at the command line will give you a brief description of the +`--help` option at the command line will give you a brief description of the usage of the program. All options consist of a leading character <tt>-</tt>, diff --git a/doc/htmlcmds.doc b/doc/htmlcmds.doc index 2afb213..7038e99 100644 --- a/doc/htmlcmds.doc +++ b/doc/htmlcmds.doc @@ -25,7 +25,7 @@ of a HTML tag are passed on to the HTML output only <ul> <li><tt>\<A HREF="..."\></tt> Starts a hyperlink (if supported by the output format). -<li><tt>\<A NAME="..."\></tt> Starts an named anchor +<li><tt>\<A NAME="..."\></tt> Starts a named anchor (if supported by the output format). <li><tt>\</A\></tt> Ends a link or anchor <li><tt>\<B\></tt> Starts a piece of text displayed in a bold font. @@ -129,7 +129,7 @@ The special HTML character entities that are recognized by Doxygen: <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 ä). <li><tt>\&?acute;</tt> where ? is one of {A,E,I,O,U,Y,a,e,i,o,u,y}, - writes a character with a acute accent (like á). + writes a character with an acute accent (like á). <li><tt>\&?grave;</tt> where ? is one of {A,E,I,O,U,a,e,i,o,u,y}, writes a character with a grave accent (like à). <li><tt>\&?circ;</tt> where ? is one of {A,E,I,O,U,a,e,i,o,u,y}, diff --git a/doc/install.doc b/doc/install.doc index 94f1099..d0878b3 100644 --- a/doc/install.doc +++ b/doc/install.doc @@ -94,7 +94,7 @@ Compilation is now done by performing the following steps: If you have Qt-4.3 or higher installed and want to build the GUI front-end, you should run the configure script with - the <code>--with-doxywizard</code> option: + the `--with-doxywizard` option: configure --with-doxywizard @@ -148,10 +148,10 @@ Use <code>make install_docs</code> to install the documentation and examples into <code>\<docdir\>/doxygen</code>. <code>\<prefix\></code> defaults to <code>/usr/local</code> but can be changed with -the <code>--prefix</code> option of the configure script. +the `--prefix` option of the configure script. The default <code>\<docdir\></code> directory is <code>\<prefix\>/share/doc/packages</code> and can be changed with -the <code>--docdir</code> option of the configure script. +the `--docdir` option of the configure script. Alternatively, you can also copy the binaries from the <code>bin</code> directory manually to some <code>bin</code> directory in your search path. @@ -226,14 +226,14 @@ Manually adding `-Bdynamic` after the target rule in Older versions of the GNU compiler have problems with constant strings containing characters with character codes larger than 127. Therefore -the compiler will fail to compile some of the translator_xx.h files. +the compiler will fail to compile some of the `translator_xx.h` files. A workaround, if you are planning to use the English translation only, -is to configure doxygen with the <code>--english-only</code> option. +is to configure doxygen with the `--english-only` option. On some platforms (such as OpenBSD) using some versions of gcc with -O2 can lead to eating all memory during the compilation of files -such as config.cpp. As a workaround use --debug as a configure option -or omit the -O2 for the particular files in the Makefile. +such as config.cpp. As a workaround use `--debug` as a configure option +or omit the `-O2` for the particular files in the Makefile. Gcc versions before 2.95 may produce broken binaries due to bugs in these compilers. diff --git a/doc/markdown.doc b/doc/markdown.doc index 90caebe..b539410 100644 --- a/doc/markdown.doc +++ b/doc/markdown.doc @@ -65,11 +65,11 @@ Just like Markdown, doxygen supports two types of headers Level 1 or 2 headers can be made as the follows - This is an level 1 header - ========================= + This is a level 1 header + ======================== - This is an level 2 header - ------------------------- + This is a level 2 header + ------------------------ A header is followed by a line containing only ='s or -'s. Note that the exact amount of ='s or -'s is not important as long as @@ -530,7 +530,7 @@ stars, so the following will appear as-is: a_nice_identifier Furthermore, a `*` or `_` only starts an emphasis if -- it is followed by an alphanumberical character, and +- it is followed by an alphanumerical character, and - it is preceded by a space, newline, or one the following characters `<{([,:;` An emphasis ends if @@ -574,7 +574,7 @@ following as one list with 3 numbered items: Doxygen however requires that the numbers used as marks are in strictly ascending order, so the above example would produce 3 lists -with one item. An item with a equal or lower number than +with one item. An item with an equal or lower number than the preceding item, will start a new list. For example: 1. Item1 of list 1 diff --git a/doc/searching.doc b/doc/searching.doc index 55b23dc..4b742f8 100644 --- a/doc/searching.doc +++ b/doc/searching.doc @@ -164,7 +164,7 @@ has its own advantages and disadvantages: doxygen as a help plugin. It will then appear as a topic in the help browser that can be started from "Help contents" in the Help menu. Eclipse will generate a search index for the documentation when you - first search for an keyword. + first search for a keyword. To enable the help plugin set \ref cfg_generate_eclipsehelp "GENERATE_ECLIPSEHELP" to \c YES, diff --git a/doc/trouble.doc b/doc/trouble.doc index c71e63d..84fb835 100644 --- a/doc/trouble.doc +++ b/doc/trouble.doc @@ -109,7 +109,7 @@ 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 - <code>doxygen --version</code> if you are not sure). + `doxygen --version` if you are not sure). - The name and version number of your operating system (for instance SuSE Linux 6.4) - It is usually a good idea to send along the configuration file as well, |