summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAaron Faanes <dafrito@gmail.com>2013-09-17 16:40:49 -0500
committerKristian Høgsberg <krh@bitplanet.net>2013-09-21 11:29:08 -0700
commit217909c18d0a7f8a4e91c9a56ccec3b75ca6d532 (patch)
treee798049b53bf63dddb0b72a8f2ecda65dd390187
parent2e3af5e5d71c3fca1b8823488985572a96ca1a0b (diff)
doc: Create \comment alias for C-style comments
Since /* */ do not nest, documentation is forced to either use C++ style // comments or some other foreign notation. This commit provides an alias that allows C-style comments to be introduced in code blocks that support aliases. It should be noted that this macro will not work within \code blocks, as Doxygen commands are ignored there. Instead, Doxygen's fenced code blocks (created via ~~~) must be used for proper output. To demonstrate: ~~~ struct example_node { int id; \comment{Other members ...} }; ~~~ will roughly yield the following HTML (excluding syntax highlighting): <pre> struct example_node { int id; /* Other members ... */ }; </pre>
-rw-r--r--doc/doxygen/wayland.doxygen.in2
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/doxygen/wayland.doxygen.in b/doc/doxygen/wayland.doxygen.in
index 7a2ac62..dd98594 100644
--- a/doc/doxygen/wayland.doxygen.in
+++ b/doc/doxygen/wayland.doxygen.in
@@ -193,7 +193,7 @@ TAB_SIZE = 8
# will result in a user-defined paragraph with heading "Side Effects:".
# You can put \n's in the value part of an alias to insert newlines.
-ALIASES =
+ALIASES += comment{1}="/* \1 *<!-- -->/"
# This tag can be used to specify a number of word-keyword mappings (TCL only).
# A mapping has the form "name=value". For example adding