Replace literal "<" with "<" in HTML documentation
Even though browsers manage to display unpaired "<"s correctly, using them is still wrong and they confuse other tools, e.g. syntax highlighting in the editors.
This commit is contained in:
parent
2b7bf3c850
commit
0fa55e4e80
1 changed files with 7 additions and 7 deletions
|
|
@ -122,7 +122,7 @@ Documenting the code</A>). Here they are:
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
Also any of the above with '<' added after comment-starting symbol,
|
Also any of the above with '<' added after comment-starting symbol,
|
||||||
like <i>/**<, /*!<, ///<, </i> or <i> //!<</i> will be
|
like <i>/**<, /*!<, ///<, </i> or <i> //!<</i> will be
|
||||||
treated as post-comment and will be assigned to the node before the
|
treated as post-comment and will be assigned to the node before the
|
||||||
comment.
|
comment.
|
||||||
|
|
@ -164,8 +164,8 @@ After C\C++ expressions at the end of the line:
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<div class="code"><pre>
|
<div class="code"><pre>
|
||||||
int someVariable = 9; ///< This is a var holding magic number 9
|
int someVariable = 9; ///< This is a var holding magic number 9
|
||||||
void doNothing(); ///< This does nothing, nop
|
void doNothing(); ///< This does nothing, nop
|
||||||
</pre></div>
|
</pre></div>
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
|
|
@ -174,7 +174,7 @@ and in some special cases, like function parameter comments:
|
||||||
|
|
||||||
<div class="code"><pre>
|
<div class="code"><pre>
|
||||||
void someFunction(
|
void someFunction(
|
||||||
int a ///< Some parameter
|
int a ///< Some parameter
|
||||||
);
|
);
|
||||||
</pre></div>
|
</pre></div>
|
||||||
|
|
||||||
|
|
@ -185,8 +185,8 @@ or enum element comments:
|
||||||
<div class="code"><pre>
|
<div class="code"><pre>
|
||||||
enum E_NUMBERS
|
enum E_NUMBERS
|
||||||
{
|
{
|
||||||
EN_ZERO, ///< The first enum item, gets zero as it's value
|
EN_ZERO, ///< The first enum item, gets zero as it's value
|
||||||
EN_ONE, ///< The second, EN_ONE=1
|
EN_ONE, ///< The second, EN_ONE=1
|
||||||
EN_THREE
|
EN_THREE
|
||||||
};
|
};
|
||||||
</pre></div>
|
</pre></div>
|
||||||
|
|
@ -623,7 +623,7 @@ Here is the list of all Doxygen tags and the description of how they are transla
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td>\par</td>
|
<td>\par</td>
|
||||||
<td>replaced with <p alt='title'>...</p></td>
|
<td>replaced with <p alt='title'>...</p></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td>\param</td>
|
<td>\param</td>
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue