ace-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From build...@apache.org
Subject svn commit: r804289 - /websites/staging/ace/trunk/content/dev-doc/coding-standards.html
Date Wed, 08 Feb 2012 23:26:54 GMT
Author: buildbot
Date: Wed Feb  8 23:26:54 2012
New Revision: 804289

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:26:54 2012
@@ -283,11 +283,32 @@
 
 <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>
-<h2 id="tag-short-description">Tag                  | Short description</h2>
-<p><code>&lt;p&gt;</code>                | New paragraph.
-<code>&lt;br&gt;</code>               | Break, a carriage return. For
separation of two paragraphs, usage of <p> is preferred.
-<code>&lt;ul&gt;&lt;li&gt;&lt;/li&gt;&lt;/ul&gt;</code>
| Unordered list of items. Each item should start with a <li> tag. Most browsers format
this as a bullet list.
-<code>&lt;code&gt;&lt;/code&gt;</code>      | Code samples. Use
this when refering to class names, method names, parameter names, etc.</p>
+<table>
+<thead>
+<tr>
+<th>Tag</th>
+<th>Short description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><code>&lt;p&gt;</code></td>
+<td>New paragraph.</td>
+</tr>
+<tr>
+<td><code>&lt;br&gt;</code></td>
+<td>Break, a carriage return. For separation of two paragraphs, usage of <p>
is preferred.</td>
+</tr>
+<tr>
+<td><code>&lt;ul&gt;&lt;li&gt;&lt;/li&gt;&lt;/ul&gt;</code></td>
+<td>Unordered list of items. Each item should start with a <li> tag. Most browsers
format this as a bullet list.</td>
+</tr>
+<tr>
+<td><code>&lt;code&gt;&lt;/code&gt;</code></td>
+<td>Code samples. Use this when refering to class names, method names, parameter names,
etc.</td>
+</tr>
+</tbody>
+</table>
 <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>/**



Mime
View raw message