Minor formatting updates to doxygen docs
This commit is contained in:
parent
1ac371369e
commit
4ebc3e05ad
1 changed files with 6 additions and 5 deletions
|
|
@ -117,14 +117,15 @@ Documenting the code</a>). Here they are:
|
|||
</pre></div>
|
||||
|
||||
<p>
|
||||
Also any of the above with '<' added after comment-starting symbol,
|
||||
like <i>/**<, /*!<, ///<, </i> or <i> //!<</i> will be
|
||||
Also any of the above with '<tt><</tt>' added after comment-starting symbol,
|
||||
like <tt>/**<, /*!<, ///<, </tt> or <tt> //!<</tt> will be
|
||||
treated as a post-comment and will be assigned to the code before the
|
||||
comment.
|
||||
|
||||
Any number of '*' or '/' within a Doxygen comment is considered to be a
|
||||
separator and is not included in the final comment, so you may safely use
|
||||
comments like <i>/*********/</i> or <i>//////////</i>.
|
||||
Any number of '<tt>*</tt>' or '<tt>/</tt>' within a Doxygen comment is
|
||||
considered to be a separator and is not included in the final comment,
|
||||
so you may safely use comments like <tt>/*********/</tt>
|
||||
or <tt>//////////</tt>.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue