summaryrefslogtreecommitdiffstats
path: root/doc/xmlcmds.doc
diff options
context:
space:
mode:
authoralbert-github <albert.tests@gmail.com>2018-07-19 16:56:38 (GMT)
committeralbert-github <albert.tests@gmail.com>2018-07-19 16:56:38 (GMT)
commitf2b6959dff5b5d3d2bbbe8204b1fc32905003ad3 (patch)
treea105c94d2a10f8decc404287269d886d39a0a2b7 /doc/xmlcmds.doc
parent3e310e8d977ab9a3341c6d40336337f530ed9e4c (diff)
downloadDoxygen-f2b6959dff5b5d3d2bbbe8204b1fc32905003ad3.zip
Doxygen-f2b6959dff5b5d3d2bbbe8204b1fc32905003ad3.tar.gz
Doxygen-f2b6959dff5b5d3d2bbbe8204b1fc32905003ad3.tar.bz2
Bug 610436 - <![CDATA[ is not handled inside C# comments
Added handling of "<![CDATA[ ... ]]>" i.e. XML CDATA sections in an analogous way top HTML comment but in this case the text is retained (as normal doxygen comment) and the special XML characters `<`,`>` and `&` are taken as if they were escaped.
Diffstat (limited to 'doc/xmlcmds.doc')
-rw-r--r--doc/xmlcmds.doc3
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/xmlcmds.doc b/doc/xmlcmds.doc
index 501bf91..848858d 100644
--- a/doc/xmlcmds.doc
+++ b/doc/xmlcmds.doc
@@ -70,6 +70,9 @@ Here is the list of tags supported by doxygen:
<li><tt>\<typeparamref name="paramName"\></tt> Refers to a parameter with name
"paramName". Similar to using \ref cmda "\\a".
<li><tt>\<value\></tt> Identifies a property. Ignored by doxygen.
+<li><tt>\<![CDATA[...]]\></tt> The text inside this tag (on the ...) is handled as normal
+ doxygen comment except for the XML special characters `<`, `>` and
+ `&` that are used as if they were escaped.
</ul>
Here is an example of a typical piece of code using some of the above commands: