APL Wiki
User Command ADOC
Overview
ADOC is a utility useful to generate documentation (semi-) automatically from class scripts as well as namespace scripts.
Obviously it makes sense to make ADOC's services available as a User Command.
This page offers a small class script ADOC which is designed to do exactly that.
Refer to UserCommands/WhereShouldTheyGo for advice how to organize your User Commands.
Samples
Given that the two different ADOC scripts went into the right folders, this would be a sample session:
]?ADoc
Command "TOOLS.ADoc". Syntax:
Accepts modifiers -browser= -summary[=] -title=
Modifier 'summary' accepts only values "full"
Automated documentation generation
]??ADoc ⍝ for syntax details
]???ADoc ⍝ to view the complete ADoc documentation in a browser window
Script location: ...
]??ADoc
Command "TOOLS.ADoc". Syntax:
Accepts modifiers -browser= -summary[=] -title=
Modifier 'summary' accepts only values "full"
Gathers information about one or more classes and/or namespaces.
Either compiles an HTML page which is then displayed in a browser (default) or prints summarizing
information to the session (-summary).
-title={text} Add a custom title with the content {text}
-browser={path} Use the non-default browser specified
-summary[=full] Return summarized information about the object members (optionally including full
functions headers)
Examples:
]ADoc MyClass ⍝ single class
]ADoc MyClass FilesAndDirs ⍝ two classes
]ADoc MyClass -title="My Doc" ⍝ custom title
]ADoc MyClass -browser="c:\opera.exe" ⍝ custom browser
]ADoc MyClass -summary ⍝ basic info about #.MyClass
]???ADoc ⍝ to view the complete ADoc documentation in a browser window
Script location: ...
]???ADoc
Shows extensive information about ADOC in your default browser.
Download
This user command cannot be downloaded on its own. It is part of the ADOC download: only together with the workspace can the user command be executed. See http://download.aplwiki.com
Version
The User Command script is version 2.38 from 2017-06-27.
Author: KaiJaeger