Comment Markup:
Documentation comment structure:
/**
* brief description
*
* long description
*
* taglets
*/
Linebreaks and paragraphs:
Comment:
/**
* First paragraph,
* still the first paragraph
*
* Second paragraph, first line,<<BR>>
* second paragraph, second line
*/
Output:
First paragraph, still the first paragraph
Second paragraph, first line,
second paragraph, second line
Text highlighting:
Comment:
/**
* ''bold'' //italic// __underlined__ ``block quote``,
* ''//__bold italic underlined__//''
*/
Output:
bold italic underlined block quote bold italic underlined
Lists:
Two spaces are required after newlines.
Comment:
/**
* short description
*
* 1. numbered list
* 1. numbered list
* 1. numbered list
*
* # numbered list
* # numbered list
* # numbered list
*
* i. numbered list
* i. numbered list
* i. numbered list
*
* I. numbered list
* I. numbered list
* I. numbered list
*
* a. alphabetical list
* a. alphabetical list
* a. alphabetical list
*
* A. alphabetical list
* A. alphabetical list
* A. alphabetical list
*
* * doted list
* * doted list
* * doted list
*
* A. alphabetical list
* a. alphabetical list
* a. alphabetical list
* A. alphabetical list
* a. alphabetical list
* a. alphabetical list
* A. alphabetical list
*/
Output:
- numbered list
- numbered list
- numbered list
- numbered list
- numbered list
- numbered list
- numbered list
- numbered list
- numbered list
- numbered list
- numbered list
- numbered list
- alphabetical list
- alphabetical list
- alphabetical list
- alphabetical list
- alphabetical list
- alphabetical list
- doted list
- doted list
- doted list
- alphabetical list
- alphabetical list
- alphabetical list
- alphabetical list
- alphabetical list
- alphabetical list
- alphabetical list
Lists:
Comment:
/**
* Short description
*
* {{{
* static int main (string[] arg) {
* return 0;
* }
* }}}
*
*/
Output:
Short description
static int main (string[] arg) {
return 0;
}
Images and links:
Comment:
/**
* [[http://google.at|google]] [[http://google.at]]
*
* {{/images/logo.png}} {{/images/logo.png|alt-message}}
*/
Output:
Tables:
Comment:
/**
* Short description
*
* || ''headline'' || ''headline'' ||
* || one cell || one cell ||
* || one cell || one cell ||
*
*/
Output:
Short description
| headline |
headline |
| one cell |
one cell |
| one cell |
one cell |
Wiki Markup:
Linebreaks, paragraphs, tables, ...
See the comment-section for details.
Headlines:
Comment:
= headline 1 =
== healdline 2 ==
=== healdline 3 ===
==== healdline 4 ====
Output:
headline 1
headline 2
headline 3
headline 4
Taglets:
There are two types of taglets:
- Inline taglets
- Block taglets
Inline taglets (link, inheritDoc) are used inside text and block taglets (param, see, ..) are used at the end of each comment.
Inline Taglets:
| Taglets: |
Synopsis: |
Descriptions: |
| inheritDoc |
{@inheritDoc} |
Used to directly inherit descriptions from the parent |
| link |
{@link [node]} |
- |
Block Taglets:
| Taglets: |
Synopsis: |
Descriptions: |
| deprecated |
@deprecated [version] |
- |
| see |
@see [node-name] |
- |
| param |
@param [parameter-name] [description] |
- |
| since |
@since [version] |
- |
| return |
@return [description] |
- |
| throws |
@throws [type-name] [description] |
- |
