Author: buildbot
Date: Wed Feb 8 23:25:43 2012
New Revision: 804288
Log:
Staging update by buildbot for ace
Modified:
websites/staging/ace/trunk/content/dev-doc/coding-standards.html
Modified: websites/staging/ace/trunk/content/dev-doc/coding-standards.html
==============================================================================
--- websites/staging/ace/trunk/content/dev-doc/coding-standards.html (original)
+++ websites/staging/ace/trunk/content/dev-doc/coding-standards.html Wed Feb 8 23:25:43 2012
@@ -281,13 +281,13 @@
</pre></div>
-<p>h5. HTML tags</p>
+<h6 id="html_tags">HTML tags</h6>
<p>For class headers, method headers and member variables JavaDoc is used in order
to generate API documentation. Some HTML-tags that can be used in order to make the comment
blocks more readable:</p>
-<p>||Tag||Short description||
-|<p>|New paragraph.|
-|<br>|Break, a carriage return. For separation of two paragraphs, usage of <p>
is preferred.|
-|<ul><li></li></ul>|Unordered list of items. Each item should start
with a <li> tag. Most browsers format this as a bullet list.|
-|<code></code>|Code samples. Use this when refering to class names, method names,
parameter names, etc.|</p>
+<h2 id="tag-short-description">Tag | Short description</h2>
+<p><code><p></code> | New paragraph.
+<code><br></code> | Break, a carriage return. For
separation of two paragraphs, usage of <p> is preferred.
+<code><ul><li></li></ul></code>
| Unordered list of items. Each item should start with a <li> tag. Most browsers format
this as a bullet list.
+<code><code></code></code> | Code samples. Use
this when refering to class names, method names, parameter names, etc.</p>
<p>{note}There is no need to embed the parameter name in the @param tag in <code>
tags; this is done by JavaDoc automatically. The same holds for the exception name in the
@exception or @throws tag. In the clarifying text however, use the <code> tags when
refering to parameter names etc. The example below shows the <code> tag being used for
the array parameter in the text, but not in its definition.{note}</p>
<p>Example:</p>
<div class="codehilite"><pre>/**
|