Free Trial

Safari Books Online is a digital library providing on-demand subscription access to thousands of learning resources.


  • Create BookmarkCreate Bookmark
  • Create Note or TagCreate Note or Tag
  • DownloadDownload
  • PrintPrint
Share this Page URL
Help

Chapter 13: Using ASDoc > Running the ASDoc tool - Pg. 273

280 CHAPTER 13 Tag or Code <img> Description 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> <strong> <em> &lt; &gt; &amp; &#x2014; &#x99; Applies monospace formatting. You must close this tag. Applies bold text formatting. You must close this tag. Applies italic formatting. You must close this tag. Less-than operator (<) . Ensure that you include the final semicolon (;). Greater-than operator (>). Ensure that you include the final semicolon (;). Ampersand (&). Ensure that you include the final semicolon (;). Em dash. Trademark symbol (TM) that is not registered. This character is superscript by default, so do not enclose it in <sup> tags. Nonbreaking space. Registered trademark symbol (®). Enclose this character in <sup> tags to make it superscript. Degree symbol. Do not use an @ sign in an ASDoc comment; instead, insert the HTML character code: &#64;. &#xA0; &#xAE; &#xB0; @ 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