Specifications

CHAPTER 13
280
Running the ASDoc tool
You use the following options to specify the list of classes processed by the asdoc command: doc-classes, doc-
sources
, doc-namespaces. The doc-classes and doc-namespaces options require you to specify the
source-path option to specify the root directory of your files.
The most basic example is to specify a class or list of classes using the
doc-classes option, as the following
example shows:
asdoc -source-path . -doc-classes comps.GraphingWidget comps.GraphingWidgetTwo
<img>
Inserts an image. To create the correct amount of space around an image, enclose the image reference in
<p></p> tags. Captions are optional; if you use a caption, make it boldface. You must close the <img> tag by
ending it with
/>, as the following example shows:
<img src = "../../images/matrix.jpg" />
<code>
Applies monospace formatting. You must close this tag.
<strong>
Applies bold text formatting. You must close this tag.
<em>
Applies italic formatting. You must close this tag.
&lt;
Less-than operator (<) . Ensure that you include the final semicolon (;).
&gt;
Greater-than operator (>). Ensure that you include the final semicolon (;).
&amp;
Ampersand (&). Ensure that you include the final semicolon (;).
&#x2014;
Em dash.
&#x99;
Trademark symbol (™) that is not registered. This character is superscript by default, so do not enclose it in <sup>
tags.
&#xA0;
Nonbreaking space.
&#xAE;
Registered trademark symbol (®). Enclose this character in <sup> tags to make it superscript.
&#xB0;
Degree symbol.
@
Do not use an @ sign in an ASDoc comment; instead, insert the HTML character code: &#64;.
Tag or Code Description