APL Wiki|
Size: 2275
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 1: | Line 1: |
| ## page was renamed from UserCommand_Adoc ## page was renamed from UserCommandAdoc = User Command ADOC (Dyalog) = |
= User Command ADOC = |
| Line 5: | Line 3: |
| == Overview == | Note that the ADOC user command project has relocated to !GitHub: https://github.com/aplteam/ADOC |
| Line 7: | Line 5: |
| [[ADOC]] is a utility useful to generate documentation (semi-) automatically from class scripts as well as namespace scripts. | Since version 16.0 it became an official Dyalog user command and is therefore available with any standard installation of Dyalog APL. |
| Line 9: | Line 7: |
| Obviously it makes sense to make ADOCs services available as a User Command. This page offers a small class script `ADOC` which is designed to do exactly that. == Assumptions == When User Commands got introduced in Dyalog with version 12.1, the User Commands where expected to reside in a sub folder `Salt\Spice` inside the Dyalog installation folder. This means that the script `ADOC.dyalog` attached to this page must go into this directory. Only then the User Commd "ADOC" is recognized. That script, which represents the ADOC User Command, assumes that there is a sibling folder of `SALT` available named `UserCommands`. Please make sure that the [[ADOC]] script is copied into this folder `UserCommands`. This enables the User Command script to address the real ADOC script as `..\UserCommands\ADOC`. == Samples == Given that the two different ADOC scripts went into the right folders, this would be a sample session: {{{ ]?ADOC "??" for general help, "?CMD" for more specific info on command CMD Group Name Description ===== ==== =========== ADOC ADOC.Browse Creates full documentation and displayes it in the default browser ADOC.List Prints syntax of all public stuff to the session ]?ADOC.Browse Command "ADOC.Browse". Syntax: 1 arguments; accepts switches -b= Script location: ........\SALT\Spice\ADOC Gathers all sort of information from a class script, compiles an HTML page with these pieces of information and displays it in a browser. Use the -b flag to specify a browser different from your default browser. ]?ADOC.List Command "ADOC.List". Script location: ........\SALT\Spice\ADOC 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 ADOC -b=Opera Watch your browser }}} == Version == The scripts is version 1.0 from 2009-10-20 Author: KaiJaeger |
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.