/** * brief description * * long description * * taglets */
/** * First paragraph, * still the first paragraph * * Second paragraph, first line,<<BR>> * second paragraph, second line */
First paragraph, still the first paragraph
Second paragraph, first line,
second paragraph, second line
/** * ''bold'' //italic// __underlined__ ``block quote``, * ''//__bold italic underlined__//'' */
bold italic underlined block quote bold italic underlined
/** * 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 */
/**
* Short description
*
* {{{
* static int main (string[] arg) {
* return 0;
* }
* }}}
*
*/
Short description
static int main (string[] arg) {
return 0;
}
/**
* [[http://google.at|google]] [[http://google.at]]
*
* {{/images/logo.png}} {{/images/logo.png|alt-message}}
*/
/** * Short description * * || ''headline'' || ''headline'' || * || one cell || one cell || * || one cell || one cell || * */
Short description
| headline | headline |
| one cell | one cell |
| one cell | one cell |
See the comment-section for details.
= headline 1 = == healdline 2 == === healdline 3 === ==== healdline 4 ====
There are two types of taglets:
Inline taglets (link, inheritDoc) are used inside text and block taglets (param, see, ..) are used at the end of each comment.
| Taglets: | Synopsis: | Descriptions: |
| inheritDoc | {@inheritDoc} | Used to directly inherit descriptions from the parent |
| link | {@link [node]} | - |
| 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] | - |