diff options
author | Dimitri van Heesch <dimitri@stack.nl> | 2003-04-21 13:56:37 (GMT) |
---|---|---|
committer | Dimitri van Heesch <dimitri@stack.nl> | 2003-04-21 13:56:37 (GMT) |
commit | 2eef94da7bc476987b1a46690bbdaeb76a05dd82 (patch) | |
tree | 3db0b381fb31e078de0540249c869667f44ec68d /doc/commands.doc | |
parent | 7e0aeda8a19448b44750f2530864432c964b0374 (diff) | |
download | Doxygen-2eef94da7bc476987b1a46690bbdaeb76a05dd82.zip Doxygen-2eef94da7bc476987b1a46690bbdaeb76a05dd82.tar.gz Doxygen-2eef94da7bc476987b1a46690bbdaeb76a05dd82.tar.bz2 |
Release-1.3-20030421
Diffstat (limited to 'doc/commands.doc')
-rw-r--r-- | doc/commands.doc | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/doc/commands.doc b/doc/commands.doc index e478a3e..3c764e2 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -129,6 +129,7 @@ documentation: \refitem cmdversion \\version \refitem cmdwarning \\warning \refitem cmdweakgroup \\weakgroup +\refitem cmdxrefitem \\xrefitem \refitem cmddollar \\\$ \refitem cmdat \\\@ \refitem cmdbackslash \\\\ @@ -1027,6 +1028,38 @@ ALIASES = "english=\if english" \ sectioning command is encountered. See section \ref cmdauthor "\\author" for an example. +\section cmdxrefitem \xrefitem <key> "(heading)" "(list title)" {text} + + \addindex \\xrefitem + This command is a generalization of commands such as \ref cmdtodo "\\todo" + and \ref cmdbug "\\bug". + It can be used to create user-defined text sections which are automatically + cross-referenced between the place of occurrence and a related page, + which will be generated. On the related page all sections of + the same type will be collected. + + The first argument \<key\> is a + identifier uniquely representing the type of the section. The second argument + is a quoted string representing the heading of the section under which + text passed as the forth argument is put. The third argument (list title) + is used as the title for the related page containing all items with the + same key. The keys "todo", "test", "bug", and "deprecated" are predefined. + + To get an idea on how to use the \\xrefitem command and what its effect + is, consider the todo list, which (for English output) can be seen an + alias for the command + \verbatim \xrefitem todo "Todo" "Todo List" \endverbatim + + Since it is very tedious and error-prone to repeat the first three + parameters of the command for each section, the command is meant to + be used in combination with the \ref cfg_aliases "ALIASES" option in the + configuration file. + To define a new command \\reminder, for instance, one should add the following + line to the configuration file: + \verbatim ALIASES += "reminder=\xrefitem reminders \"Reminder\" \"Reminders\"" \endverbatim + Note the use of escaped quotes for the second and third argument of the + \\xrefitem command. + <hr> <h2>\htmlonly <center> --- \endhtmlonly Commands to create links |