From RTSC-Pedia
 | [printable version] [offline version] | offline version generated on 04-Aug-2010 21:08 UTC |  |
Command - xdc.tools.cdoc.sg
Interactive package documentation tool
Contents |
Synopsis
| | xs xdc.tools.cdoc.sg [{package|module|interface} ...] [options ...] |
For a complete description of this tool's options, see its static Cdoc reference page xdc.tools.cdoc.sg. Alternatively, you can view this reference documentation using the the tool itself!
| | % xs xdc.tools.cdoc.sg xdc.tools.cdoc.sg |
Description
The xdc.tools.cdoc.sg tool can be used to interactively browse the documentation of package contained in any collection of repositories. When you start this tool it will, by default, show all packages found along the current package path.
You see the "cdoc" window with a tree view of the RTSC packages available to you. All of these packages provide documentation that can be displayed by the CDOC viewer.
Click "+" next to a directory to expand its list of packages. Click "+" next to a package name to see the list of modules it provides. You can further expand the tree to see a list of the functions provided by a module. Double-click on a package or module to see its reference information or simply hover over an item in the tree for a brief summary.
For each topic you view, there is a tab across the top of the page area. You can use these to quickly return to other pages you have viewed. You can also use the arrows next to "Views" to move backward and forward in your history of page views.
To close a page and remove its tab, click the X on the tab.
To directly view a package's documentation without having to navigate through the tree list, simply pass the name of the package (or module) on the command line. For example, to view the xdc.tools.cdoc.sg tools reference documentation (using itself!), type the following command:
| | % xs xdc.tools.cdoc.sg xdc.tools.cdoc.sg |
| [printable version] [offline version] | offline version generated on 04-Aug-2010 21:08 UTC | |
