Differences between revisions 1 and 2
Revision 1 as of 2009-10-20 19:38:59
Size: 1781
Editor: KaiJaeger
Comment:
Revision 2 as of 2009-10-20 19:42:00
Size: 1884
Editor: KaiJaeger
Comment:
Deletions are marked like this. Additions are marked like this.
Line 13: Line 13:
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. 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.
Line 15: Line 15:
The ADOC User Command assumes that there is a sibling folder of `SALT` 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`.

The script '''ADOC''' attached to this page needs to go into `SALT\SPICE`
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`.

User Command ADOC (Dyalog)

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 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

      ]?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

Author: KaiJaeger


CategoryDyalogUserCommands

UserCommands/WhereShouldTheyGo (last edited 2019-05-30 09:04:34 by KaiJaeger)