Differences between revisions 4 and 21 (spanning 17 versions)
Revision 4 as of 2009-10-20 19:56:13
Size: 2190
Editor: KaiJaeger
Comment:
Revision 21 as of 2011-08-05 12:04:48
Size: 1724
Editor: KaiJaeger
Comment: Tidied up
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
= User Command ADOC (Dyalog) =
= User Command ADOC =
Line 4: Line 3:
Line 7: Line 5:
Obviously it makes sense to make ADOCs services available as a User Command. Obviously it makes sense to make ADOC's services available as a User Command.
Line 11: Line 9:
== 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`.
Refer to UserCommands/WhereShouldTheyGo for advice how to organize your User Commands.
Line 18: Line 12:
Line 27: Line 20:
 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 ADOC.Browse Creates full documentation and displayes it in the default browser.
        ADOC.HELP    Displays help regarding ADOC.
        ADOC.List Prints sy
ntax of all public stuff to the session.
Line 32: Line 26:
Script location: ........\SALT\Spice\ADOC Script location: ........\....\....\ADOC
Line 34: Line 28:
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.
Gathers information from a class script, compiles
an HTML page with these pieces of information
and displays it in your default browser.
Line 41: Line 34:
Script location: ........\SALT\Spice\ADOC Script location: ........\...\...\ADOC
Line 46: Line 39:
]ADOC.Browse ADOC -b=Opera ]ADOC.Help
Line 48: Line 41:

Shows extensive information about ADOC. It's basically doing `ADOC.Browse ADOC`.
Line 50: Line 45:
== Download ==

[[attachment:ADOC_UC.zip | Download]] the script.
Line 51: Line 50:

The scripts is version 1.0 from 2009-10-20
The script is version 1.2.0 from 2011-08-04
Line 55: Line 53:

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
"??" 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.HELP    Displays help regarding ADOC.
        ADOC.List    Prints syntax of all public stuff to the session.

      ]?ADOC.Browse
Command "ADOC.Browse". Syntax: 1 arguments; accepts switches -b=
Script location: ........\....\....\ADOC

Gathers information from a class script, compiles
an HTML page with these pieces of information
and displays it in your default browser.

      ]?ADOC.List
Command "ADOC.List".
Script location: ........\...\...\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.Help
Watch your browser

Shows extensive information about ADOC. It's basically doing `ADOC.Browse ADOC`.

Download

Download the script.

Version

The script is version 1.2.0 from 2011-08-04

Author: KaiJaeger


CategoryDyalogUserCommands

UserCommands/Adoc (last edited 2019-05-30 07:31:15 by KaiJaeger)