Differences between revisions 32 and 34 (spanning 2 versions)
⇤ ← Revision 32 as of 2017-07-17 17:07:46 →
Size: 4240
Editor: KaiJaeger
Comment:
← Revision 34 as of 2019-05-30 07:31:15 → ⇥
Size: 298
Editor: KaiJaeger
Comment:
Deletions are marked like this. Additions are marked like this.
Line 3: Line 3:
|| '''Note:''' With version 16.0 ADOC became an official Dyalog user command|| Note that the ADOC user command project has relocated to !GitHub: https://github.com/aplteam/ADOC
Line 5: Line 5:
== 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		 Since version 16.0 it became an official Dyalog user command and is therefore available with any standard installation of Dyalog APL.

User Command ADOC

Note that the ADOC user command project has relocated to GitHub: https://github.com/aplteam/ADOC

Since version 16.0 it became an official Dyalog user command and is therefore available with any standard installation of Dyalog APL.

CategoryDyalogUserCommands

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