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.

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. Note that this script only deal with two issues:

• Figure out what command the user want to invoke, "Browse" or "List".
• Find the real work horse and call it, see below.

That script which represents the ADOC User Command assumes that there is a sibling folder of your APL installation folder available named UserCommands. Please make sure that the real ADOC script is copied into this folder UserCommands. This enables the User Command script to address the real ADOC script {MyDyalogInstallationFolder}..\UserCommands\ADOC.

For example, in case your version of Dyalog APL 32bit is installed in C:\Program Files (x86)\Dyalog\Dyalog APL 12.1 Unicode which is the default on Windows 7 64 bit, then the folder UserCommands is supposed to be located at C:\Program Files (x86)\Dyalog\UserCommands.

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.0.7 from 2011-05-28

Author: KaiJaeger

CategoryDyalogUserCommands