APL Wiki|
Size: 1898
Comment:
|
← Revision 34 as of 2019-05-30 07:31:15 ⇥
Size: 298
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 2: | Line 2: |
| == Overview == [[ADOC]] is a utility useful to generate documentation (semi-) automatically from class scripts as well as namespace scripts. |
|
| Line 5: | Line 3: |
| Obviously it makes sense to make ADOC's services available as a User Command. | Note that the ADOC user command project has relocated to !GitHub: https://github.com/aplteam/ADOC |
| Line 7: | Line 5: |
| 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.List Command "ADOC.List". Syntax: 1 arguments; accepts switches -full Script location: C:\UserCommands\ADOC_UC Prints a list with all sorts of information to the session about all public stuff given in the script specified in the right argument ]?ADOC.Browse Command "ADOC.Browse". Syntax: accepts switches -caption= -browser= Script location: C:\UserCommands\ADOC_UC Gathers all sort of information from a class script and compiles an HTML page from it which is then displayed with your default browser. Examples: ]ADOC.Browse ADOC ⍝ Single class ]ADOC.Browse ADOC,WinFile ⍝ Two classes, no blank in between! ]ADOC.Browse ADOC,WinFile -caption="My Doc" ]ADOC.Browse ADOC,WinFile -caption="My Doc" browser="c:\opera.exe Available switches: -caption="Your caption" -browser="full path to a browser which is not your default one" ]ADOC.Help Shows extensive information about ADOC. It's basically doing `ADOC.Browse ADOC`. }}} == 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 1.7.0 from 2016-01-16. Author: KaiJaeger |
Since version 16.0 it became an official Dyalog user command and is therefore available with any standard installation of Dyalog APL. |
User Command ADOC
Note that the ADOC user command project has relocated to GitHub: https://github.com/aplteam/ADOC
Since version 16.0 it became an official Dyalog user command and is therefore available with any standard installation of Dyalog APL.