ace-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ma...@apache.org
Subject svn commit: r1242171 - /ace/site/trunk/content/dev-doc/coding-standards.mdtext
Date Wed, 08 Feb 2012 23:25:39 GMT
Author: marrs
Date: Wed Feb  8 23:25:38 2012
New Revision: 1242171

URL: http://svn.apache.org/viewvc?rev=1242171&view=rev
Log:
New table syntax

Modified:
    ace/site/trunk/content/dev-doc/coding-standards.mdtext

Modified: ace/site/trunk/content/dev-doc/coding-standards.mdtext
URL: http://svn.apache.org/viewvc/ace/site/trunk/content/dev-doc/coding-standards.mdtext?rev=1242171&r1=1242170&r2=1242171&view=diff
==============================================================================
--- ace/site/trunk/content/dev-doc/coding-standards.mdtext (original)
+++ ace/site/trunk/content/dev-doc/coding-standards.mdtext Wed Feb  8 23:25:38 2012
@@ -159,15 +159,16 @@ A method block comment looks as follows:
      */
     public void setSplitterLocation(int position) throws PositionException {
 
-h5. HTML tags
+###### HTML tags
 
 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:
 
-||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.|
+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.
 
 {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}
 



Mime
View raw message