Differences between revisions 25 and 32 (spanning 7 versions)
⇤ ← Revision 25 as of 2015-04-04 08:39:44 →
Size: 1751
Editor: KaiJaeger
Comment: New version
← Revision 32 as of 2017-07-17 17:07:46 → ⇥
Size: 4240
Editor: KaiJaeger
Comment:
Deletions are marked like this. Additions are marked like this.
Line 2: Line 2:

|| '''Note:''' With version 16.0 ADOC became an official Dyalog user command||
Line 15: Line 18:
      ]?ADOC.List
Command "ADOC.List". Syntax: 1 arguments; accepts switches -full
Script location: C:\UserCommands\ADOC_UC		       ]?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 19: Line 29:
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
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 22: Line 54:
      ]?ADOC.Browse
Command "ADOC.Browse". Syntax: accepts switches -caption= -browser=
Script location: C:\UserCommands\ADOC_UC		       ]???ADoc
Line 26: Line 56:
 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`.		 Shows extensive information about ADOC in your default browser.
Line 47: Line 61:
[[attachment:ADOC_UC.zip | Download]] the script. 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 50: Line 64:
The script is version 1.5.0 from 2015-04-04 The User Command script is version 2.38 from 2017-06-27.

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

CategoryDyalogUserCommands

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