diff options
| author | Dimitri van Heesch <dimitri@stack.nl> | 2013-12-07 22:25:45 (GMT) |
|---|---|---|
| committer | Dimitri van Heesch <dimitri@stack.nl> | 2013-12-07 22:25:45 (GMT) |
| commit | bdbc5d8a2fe51cc7055365d90d7f7ce45f9dfac1 (patch) | |
| tree | 57f9fbe34db04d4c1e7078d348fd2605bcecf4d1 /doc | |
| parent | e6e3da98ec320ca5b3ad68f446fdfe75c3478961 (diff) | |
| parent | a481a84fdf39cdf40b38ebaad86b2a159db4c383 (diff) | |
| download | Doxygen-bdbc5d8a2fe51cc7055365d90d7f7ce45f9dfac1.zip Doxygen-bdbc5d8a2fe51cc7055365d90d7f7ce45f9dfac1.tar.gz Doxygen-bdbc5d8a2fe51cc7055365d90d7f7ce45f9dfac1.tar.bz2 | |
Merge pull request #61 from albert-github/feature/bug_719639
Bug 719639 - @xrefitem with empty heading string
Diffstat (limited to '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 |