APL Wiki|
Size: 2190
Comment:
|
Size: 4240
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| = User Command ADOC (Dyalog) = | = User Command ADOC = || '''Note:''' With version 16.0 ADOC became an official Dyalog user command|| |
| Line 4: | Line 6: |
| Line 7: | Line 8: |
| 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 12: |
| == 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 15: |
| Line 22: | Line 18: |
| ]?ADOC "??" for general help, "?CMD" for more specific info on command CMD |
]?ADoc Command "TOOLS.ADoc". Syntax: Accepts modifiers -browser= -summary[=] -title= Modifier 'summary' accepts only values "full" Automated documentation generation ]??ADoc ⍝ for syntax details ]???ADoc ⍝ to view the complete ADoc documentation in a browser window Script location: ... |
| Line 25: | Line 29: |
| 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 Command "TOOLS.ADoc". Syntax: Accepts modifiers -browser= -summary[=] -title= Modifier 'summary' accepts only values "full" Gathers information about one or more classes and/or namespaces. Either compiles an HTML page which is then displayed in a browser (default) or prints summarizing information to the session (-summary). -title={text} Add a custom title with the content {text} -browser={path} Use the non-default browser specified -summary[=full] Return summarized information about the object members (optionally including full functions headers) Examples: ]ADoc MyClass ⍝ single class ]ADoc MyClass FilesAndDirs ⍝ two classes ]ADoc MyClass -title="My Doc" ⍝ custom title ]ADoc MyClass -browser="c:\opera.exe" ⍝ custom browser ]ADoc MyClass -summary ⍝ basic info about #.MyClass ]???ADoc ⍝ to view the complete ADoc documentation in a browser window Script location: ... |
| Line 30: | Line 54: |
| ]?ADOC.Browse Command "ADOC.Browse". Syntax: 1 arguments; accepts switches -b= Script location: ........\SALT\Spice\ADOC |
]???ADoc |
| Line 34: | Line 56: |
| 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. ]?ADOC.List Command "ADOC.List". Script location: ........\SALT\Spice\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.Browse ADOC -b=Opera Watch your browser |
Shows extensive information about ADOC in your default browser. |
| Line 50: | Line 59: |
| == Download == This user command cannot be downloaded on its own. It is part of the ADOC download: only together with the workspace can the user command be executed. See http://download.aplwiki.com |
|
| Line 51: | Line 64: |
The scripts is version 1.0 from 2009-10-20 |
The User Command script is version 2.38 from 2017-06-27. |
| Line 55: | Line 67: |
User Command ADOC
Note: With version 16.0 ADOC became an official Dyalog user command |
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
Command "TOOLS.ADoc". Syntax:
Accepts modifiers -browser= -summary[=] -title=
Modifier 'summary' accepts only values "full"
Automated documentation generation
]??ADoc ⍝ for syntax details
]???ADoc ⍝ to view the complete ADoc documentation in a browser window
Script location: ...
]??ADoc
Command "TOOLS.ADoc". Syntax:
Accepts modifiers -browser= -summary[=] -title=
Modifier 'summary' accepts only values "full"
Gathers information about one or more classes and/or namespaces.
Either compiles an HTML page which is then displayed in a browser (default) or prints summarizing
information to the session (-summary).
-title={text} Add a custom title with the content {text}
-browser={path} Use the non-default browser specified
-summary[=full] Return summarized information about the object members (optionally including full
functions headers)
Examples:
]ADoc MyClass ⍝ single class
]ADoc MyClass FilesAndDirs ⍝ two classes
]ADoc MyClass -title="My Doc" ⍝ custom title
]ADoc MyClass -browser="c:\opera.exe" ⍝ custom browser
]ADoc MyClass -summary ⍝ basic info about #.MyClass
]???ADoc ⍝ to view the complete ADoc documentation in a browser window
Script location: ...
]???ADoc
Shows extensive information about ADOC in your default browser.
Download
This user command cannot be downloaded on its own. It is part of the ADOC download: only together with the workspace can the user command be executed. See http://download.aplwiki.com
Version
The User Command script is version 2.38 from 2017-06-27.
Author: KaiJaeger