APL Wiki|
Size: 1884
Comment:
|
Size: 368
Comment: User command "Latest" introduced
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| = User Command ADOC (Dyalog) = | <<TableOfContents>> = User Command "Latest" = /!\ This page is under construction |
| Line 5: | Line 9: |
| [[ADOC]] is a utility useful to generate documentation (semi-) automatically from class scripts as well as namespace scripts. | == Download == |
| Line 7: | Line 11: |
| Obviously it makes sense to make ADOCs services available as a User Command. | [[attachment:Latest_UC.zip | Download]] the script and the workspace. |
| Line 9: | Line 13: |
| 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 ]?ADOC.List Command "ADOC.List". Script location: ........\SALT\Spice\ADOC Prints a list with all sorts of information to the session ]ADOC.Browse ADOC -b=Opera Watch your browser }}} |
== Version == The script is version 1.0.0 from 2012-03-05 |
| Line 45: | Line 17: |
-- KaiJaeger <<DateTime(2012-03-05T14:37:53Z)>> |
- Diff for "UserCommands/Latest2"
![/!\](/moin_static198/dyalog/img/alert.png "/!\"){kind=small}
This page is under construction