Details
-
Bug
-
Resolution: Unresolved
-
P3: Somewhat important
-
None
-
6.2
Description
When QDoc parses a QDoc block comment (delimited between /*! and */), it will stop parsing as soon as a closing delimiter (*/) is encountered, discarding the rest of the output.
This may happen inside blocks or commands too.
For example, the following block comment will not parse correctly:
/*!
\page i_love_wildcards.html
\section1 I don't want no file!
With the \c {*/} wildcard you can match all the directories and avoid matching all those hateful files!
*/
As there are reasonable cases for why one would want */ to appear inside a document, it should be possible to escape the character sequence to avoid problems.
Inside an inline code command, supposedly, any "\" character that is followed by a character that is not alphanumeric is escaped and treated as a literal.
Nonetheless, trying to escape the "*" character in the above comment block result in the same butchered output from QDoc.
It might be worth it to consider a more encompassing solution that removes the need to escape the */ delimiter inside of commands and block commands or that provides a general and consistent solution to perform such an escape.