jyapayne/swig
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Minor formatting updates to doxygen docs

Browse source
This commit is contained in:
John McFarland 2019-08-24 10:29:11 -05:00
commit 4ebc3e05ad
1 changed files with 6 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

11
Doc/Manual/Doxygen.html
View file

@ -117,14 +117,15 @@ Documenting the code</a>). Here they are:
</pre></div> </pre></div>
<p> <p>
Also any of the above with '&lt;' added after comment-starting symbol, Also any of the above with '<tt>&lt;</tt>' added after comment-starting symbol,
like <i>/**&lt;, /*!&lt;, ///&lt;, </i> or <i> //!&lt;</i> will be like <tt>/**&lt;, /*!&lt;, ///&lt;, </tt> or <tt> //!&lt;</tt> will be
treated as a post-comment and will be assigned to the code before the treated as a post-comment and will be assigned to the code before the
comment. comment.
Any number of '*' or '/' within a Doxygen comment is considered to be a Any number of '<tt>*</tt>' or '<tt>/</tt>' within a Doxygen comment is
separator and is not included in the final comment, so you may safely use considered to be a separator and is not included in the final comment,
comments like <i>/*********/</i> or <i>//////////</i>. so you may safely use comments like <tt>/*********/</tt>
or <tt>//////////</tt>.
</p> </p>
<p> <p>