<LinkAddress>
| Inserts an in-line link with visible text label that points to the documentation for the specified package, class or member name of a referenced class. This tag is valid in all doc comments. For more details see below. |
~Italic Text~
| Use tilda (~) for
Italic Text.
|
*Bold Text*
| Use star (*) for
Bold Text.
|
Headings
| You can add headings to your output just by ending a line with a colon and having a blank line above it. |
Bullet Lists
| You can add bullet lists by starting a line with
a dash, an asterisk, an o, or a plus. Bullets can have blank lines between them if you want, and subsequent lines don’t have to be indented. You end a list by skipping a line and doing something else.
|
Definition Lists
| You can add a definition list by using the format below, specifically “text space dash space text”. Like bullet lists, you can have blank lines between them if you want, subsequent lines don’t have to be indented, and you end the list by skipping a line and doing something else. |
Images
| You can include images in your documentation by writing
(see filename). If you put it alone on a line it will be embedded in place.
|
Code and Text Diagrams
| , or :'''. If you have a vertical line or text box with the comment, you must separate these symbols from it with a space. |