diff options
author | albert-github <albert.tests@gmail.com> | 2013-12-01 13:43:58 (GMT) |
---|---|---|
committer | albert-github <albert.tests@gmail.com> | 2013-12-01 13:43:58 (GMT) |
commit | d809d163b60a42850c0c4db72c1ba1ed7785416b (patch) | |
tree | 0011d7f28190c20c3cd8b594ed19fcbf0c5ce919 /doc/commands.doc | |
parent | 58058025a8357dcba0da4be0f6c3ddfec8c37839 (diff) | |
download | Doxygen-d809d163b60a42850c0c4db72c1ba1ed7785416b.zip Doxygen-d809d163b60a42850c0c4db72c1ba1ed7785416b.tar.gz Doxygen-d809d163b60a42850c0c4db72c1ba1ed7785416b.tar.bz2 |
Bug 719639 - @xrefitem with empty heading string
Adjusted documentation and in case the title is the empty string in a DocXRefItem the visitPre and visitPost do nothing.
Diffstat (limited to 'doc/commands.doc')
-rw-r--r-- | doc/commands.doc | 22 |
1 files changed, 21 insertions, 1 deletions
diff --git a/doc/commands.doc b/doc/commands.doc index b53c9d7..d13c68b 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -230,7 +230,7 @@ Structural indicators any of the commands. The title is optional, so this command can also be used to add a number of - entities to an existing group using \@{ and \@} like this: + entities to an existing group using \c \@{ and \c \@} like this: \verbatim /*! \addtogroup mygrp @@ -1740,6 +1740,26 @@ void setPosition(double x,double y,double z,double t) Note the use of escaped quotes for the second and third argument of the \c \\xrefitem command. + In case parameter "(heading)" is the empty string no heading is generated. This can be useful + when used in combination with the \ref cmdpage "\\page" command e.g. +\verbatim +/** @page my_errors My Errors + * @brief Errors page + * + * Errors page contents. + */ + +/** \error ERROR 101: in case a file can not be opened. + Check about file system read/write access. */ +#define MY_ERR_CANNOT_OPEN_FILE 101 + +/** \error ERROR 102: in case a file can not be closed. + Check about file system read/write access. */ +#define MY_ERR_CANNOT_CLOSE_FILE 102 +\endverbatim + with \c \\error defined as + \verbatim ALIASES += "error=\xrefitem my_errors \"\" \"\"" \endverbatim + <hr> \htmlonly <center> \endhtmlonly |