diff options
| author | albert-github <albert.tests@gmail.com> | 2014-01-15 12:37:01 (GMT) |
|---|---|---|
| committer | albert-github <albert.tests@gmail.com> | 2014-01-15 12:37:01 (GMT) |
| commit | dd2c137847e16d0a7c6086053f55bce501d84a0c (patch) | |
| tree | 324281ae6b269144c0230383cffb308604b4a2e3 /doc/commands.doc | |
| parent | de9e2e0b72c5f460e38f0157039836fcdfb35c21 (diff) | |
| download | Doxygen-dd2c137847e16d0a7c6086053f55bce501d84a0c.zip Doxygen-dd2c137847e16d0a7c6086053f55bce501d84a0c.tar.gz Doxygen-dd2c137847e16d0a7c6086053f55bce501d84a0c.tar.bz2 | |
Enabling possibility to have { and } in (latex) index items
In the doxygen manual the index items for \{ and \} were missing due to the missing support for the usage of { and } in parts of the code.
This patch fixes this problem by introducing 2 new latex commands. See also http://tex.stackexchange.com/questions/153291/index-unmatched-braces-in-latex
Further improvements in the index are:
- consistency in different places
- correction of index for \::
- placing \~ on a more logical place (together with other special characters, ~ is in the ASCII table after a-z whilst other characters are before this range)
Diffstat (limited to 'doc/commands.doc')
| -rw-r--r-- | doc/commands.doc | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/doc/commands.doc b/doc/commands.doc index 7b598f6..15d6827 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -2696,6 +2696,8 @@ class Receiver <hr> \section cmdfcurlyopen \\f{environment}{ + \addindex \\f{ + Marks the start of a formula that is in a specific environment. \note The second \c { is optional and is only to help editors (such as \c Vim) to do proper syntax highlighting by making the number of opening and closing braces @@ -2705,6 +2707,8 @@ class Receiver <hr> \section cmdfcurlyclose \\f} + \addindex \\f} + Marks the end of a formula that is in a specific environment. \sa section \ref cmdfcurlyopen "\\f{" and section \ref formulas "formulas". @@ -3030,7 +3034,7 @@ class Receiver \section cmdchardot \\. \addindex \\\. - This command writes a dot (\c .) to the output. This can be useful to + This command writes a dot (`.`) to the output. This can be useful to prevent ending a brief description when JAVADOC_AUTOBRIEF is enabled or to prevent starting a numbered list when the dot follows a number at the start of a line. @@ -3038,7 +3042,7 @@ class Receiver <hr> \section cmddcolon \\:: - \addindex \\\:: + \addindex \\:: This command writes a double colon (\c \::) to the output. This character sequence has to be escaped in some cases, because it is used to reference to documented entities. |