Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Escape double dashes in Doxygen input to preserve them

Browse Source 
By default double dashes are converted to en-dashes in the output (and triple
ones -- to em-dashes), but this is undesirable when double dashes are used not
as a punctuation mark but in command line options or as C++ decrement
operator, so escape them to avoid such conversion in this case.
This commit is contained in:
Vadim Zeitlin
2016-10-20 21:47:37 +02:00
parent 73f6bf7b6f
commit 0afb95d2f4
15 changed files with 29 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/doxygen/overviews/xrc.h
View File

@@ -255,19 +255,19 @@ To compile binary resource files, use the command-line @c wxrc utility. It
takes one or more file parameters (the input XRC files) and the following
switches and options:
@li -h (--help): Show a help message.
@li -v (--verbose): Show verbose logging information.
@li -c (--cpp-code): Write C++ source rather than a XRS file.
@li -e (--extra-cpp-code): If used together with -c, generates C++ header file
@li -h (\--help): Show a help message.
@li -v (\--verbose): Show verbose logging information.
@li -c (\--cpp-code): Write C++ source rather than a XRS file.
@li -e (\--extra-cpp-code): If used together with -c, generates C++ header file
containing class definitions for the windows defined by the XRC file (see
special subsection).
@li -u (--uncompressed): Do not compress XML files (C++ only).
@li -g (--gettext): Output underscore-wrapped strings that poEdit or gettext
@li -u (\--uncompressed): Do not compress XML files (C++ only).
@li -g (\--gettext): Output underscore-wrapped strings that poEdit or gettext
can scan. Outputs to stdout, or a file if -o is used.
@li -n (--function) @<name@>: Specify C++ function name (use with -c).
@li -o (--output) @<filename@>: Specify the output file, such as resource.xrs
@li -n (\--function) @<name@>: Specify C++ function name (use with -c).
@li -o (\--output) @<filename@>: Specify the output file, such as resource.xrs
or resource.cpp.
@li -l (--list-of-handlers) @<filename@>: Output a list of necessary handlers
@li -l (\--list-of-handlers) @<filename@>: Output a list of necessary handlers
to this file.
For example: