Differences between revisions 21 and 32 (spanning 11 versions)
Revision 21 as of 2011-08-05 12:04:48
Size: 1724
Editor: KaiJaeger
Comment: Tidied up
Revision 32 as of 2017-06-01 16:31:46
Size: 126
Editor: KaiJaeger
Comment:
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
= User Command ADOC =
== Overview ==
[[ADOC]] is a utility useful to generate documentation (semi-) automatically from class scripts as well as namespace scripts.
= User Commands Int2Hex and Hex2Int =
Line 5: Line 3:
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 ==

[[attachment:ADOC_UC.zip | Download]] the script.

== Version ==
The script is version 1.2.0 from 2011-08-04

Author: KaiJaeger
Authors: Logic=PhilLast, user command=KaiJaeger

User Commands Int2Hex and Hex2Int

Authors: Logic=PhilLast, user command=KaiJaeger


CategoryDyalogUserCommands

UserCommands/Hex (last edited 2019-05-30 07:48:57 by KaiJaeger)