Differences between revisions 21 and 22

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.List
Command "ADOC.List". Syntax: 1 arguments; accepts switches -full
Script location: C:\UserCommands\ADOC_UC

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
Command "ADOC.Browse". Syntax:  accepts switches -caption= -browser=
Script location: C:\UserCommands\ADOC_UC

 Gathers all sort of information from a class script and
 compiles an HTML page from it which is then displayed
 with your default browser.

 Examples:
 ]ADOC.Browse ADOC                      ⍝ Single class
 ]ADOC.Browse ADOC,WinFile    ⍝ Two classes, no blank in between!
 ]ADOC.Browse ADOC,WinFile -caption="My Doc"
 ]ADOC.Browse ADOC,WinFile -caption="My Doc" browser="c:\opera.exe

 Available switches:
 -caption="Your caption"
 -browser="full path to a browser which is not your default one"

      ]ADOC.Help

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

Download

Download the script.

Version

The script is version 1.3.0 from 2011-10-14

Author: KaiJaeger

CategoryDyalogUserCommands

-  ⇤ ← Revision 21 as of 2011-08-05 12:04:48 → 
  Size: 1724
  Editor: KaiJaeger
  Comment: Tidied up
+   ← Revision 22 as of 2011-10-14 10:55:00 → ⇥
  Size: 1751
  Editor: KaiJaeger
  Comment: New version
-Deletions are marked like this.
+Additions are marked like this.
 Line 15:
-      ]?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.
-Line 33:
+Line 16:
-Command "ADOC.List".
Script location: ........\...\...\ADOC
+Command "ADOC.List". Syntax: 1 arguments; accepts switches -full
Script location: C:\UserCommands\ADOC_UC
-Line 39:
+Line 22:
-]ADOC.Help
Watch your browser
+      ]?ADOC.Browse
Command "ADOC.Browse". Syntax:  accepts switches -caption= -browser=
Script location: C:\UserCommands\ADOC_UC

 Gathers all sort of information from a class script and
 compiles an HTML page from it which is then displayed
 with your default browser.

 Examples:
 ]ADOC.Browse ADOC   			⍝ Single class
 ]ADOC.Browse ADOC,WinFile    ⍝ Two classes, no blank in between!
 ]ADOC.Browse ADOC,WinFile -caption="My Doc"
 ]ADOC.Browse ADOC,WinFile -caption="My Doc" browser="c:\opera.exe

 Available switches:
 -caption="Your caption"
 -browser="full path to a browser which is not your default one"

      ]ADOC.Help
 Line 50:
-The script is version 1.2.0 from 2011-08-04
+The script is version 1.3.0 from 2011-10-14