AutoHotkey Community

[derRaphael]

Hi all,

Doc-O-Matic is a script, capable of tracking functions in a different AHK script and generating a HTML documentation from it.

It also supports Syntax Hiliting and inline linking to functions used by the script. A documentation to stdLib files and ahk's documentation is on the feature list for rc1, same as a stylesheet editor for a better customizing of
the look and feel.

See a Live Sample / DOWNLOAD




Code:

; Released under the Terms of EUPL 1.1 or later ; Also released under the Terms of GPL V3 or later ; (w) 2010 by derRaphael ; The software is hereby free of any guarantees ; It has been tested and developed under winxp and ahk 1.0.48.05 ; If it works, good for you. If as a result your wife wants to ; get divorced - not my beer. ; There are numerous bugs and many caveats ; the entire script is subject to change for a better functionality ; and feature design. for now only the core functionality is to ; be tested. ; Usage Limitation: Leave the Generated by Hint intact.



Closer Future Planned features:



• Customizable Syntax hiliting
  
• Custome StyleSheet Editor
  
• Support of multiple Files
  
• Support for detecting StdLib functions
  
• Support for linking to official documentation
  
• Plugin Structure
  
• Better landing organization of the HTML (instead of a large function list)
  
• Customize which data to see
  


Far Future Planned features:



• Label / HotKey / String detection
  
• Script Flow analysis for automatic behaviour documentation
  
• Much more...
  


I ask everybody who uses this script, to leave the bottom block intact, so that interested user's may be abled to see where to get the software.

See a Live Sample / DOWNLOAD

Known Bugs:

• Syntax Lexer gets comments too good (such as MsgBox aaa; bbb), thx fincs
  
• unknown if it works with ahk_l or ahk_u
  
• functionnames containing numbers wont get catched internally by the lexer
  

Have fun and please post feedback to improve this script!


dR
_________________

All scripts, unless otherwise noted, are hereby released under CC-BY

[derRaphael]

-reserved for plugins index-
_________________

All scripts, unless otherwise noted, are hereby released under CC-BY

[tank]

$%^&* in my mouth thats frakkin cool as shit i love this

Thank you
_________________

We are troubled on every side‚ yet not distressed; we are perplexed‚
but not in despair; Persecuted‚ but not forsaken; cast down‚ but not destroyed;

[doyle]

Very cool.

[Tuncay]

I will use a modified version of your script to generate on the fly documentation in my public collection of libraries. I am including the script in tools folder for automatically accessing from my script. Here are the currently changed lines, for automation reason to avoid user prompt:

[Tuncay]

Does not work on my ini library:
http://www.autohotkey.com/forum/viewtopic.php?t=46226
_________________
{1:"ahkstdlib", 2:"my libs", 3:"my apps", 4:"my license"}
--> Don't feed the troll! <--

[derRaphael]

this beta does not work with your ini library because of the preamble you used. since there are lines which start directly with an opening perenthesis, the script interprets it as a continuation section and produces rubbish. this is a major flaw of the script's design and it might take a while to get around that bug. sorry. thanks for finding it though.

dR
_________________

All scripts, unless otherwise noted, are hereby released under CC-BY

[tic]

A very clever script indeed....2 thumbs up