GenDocs - StdLib Documentation Generator

Post your working scripts, libraries and tools
User avatar
fincs
Posts: 493
Joined: 30 Sep 2013, 14:17
GitHub: fincs
Location: Seville, Spain
Contact:

GenDocs - StdLib Documentation Generator

30 Jan 2014, 17:28

[Repost]

GenDocs is a utility for easily creating documentation for AutoHotkey libraries. It supports function, classes (with methods, properties, constructors and inner classes), as well as custom-formatted pages. It works through specially-crafted comment blocks, which contain GenDocs-flavored markdown.

Download - GitHub - Documentation
fincs
Windows 10 x64 Build 14393 / AutoHotkey v1.1.24.04
Get SciTE4AutoHotkey v3.0.06.01 - [My project list]
User avatar
fischgeek
Posts: 351
Joined: 29 Jan 2014, 21:39

Re: GenDocs - StdLib Documentation Generator

30 Jan 2014, 17:42

Wondering if there's a way for me to get this working. It seems like such an awesome feature. Everytime I try to generate a doc, I get "An error happened (FileRead)! 1|"

Just trying some basic stuff from the example(s):

Code: [Select all] [Expand] [Download] GeSHi © Codebox Plus

User avatar
fincs
Posts: 493
Joined: 30 Sep 2013, 14:17
GitHub: fincs
Location: Seville, Spain
Contact:

Re: GenDocs - StdLib Documentation Generator

30 Jan 2014, 17:45

You left the "Page:" block in there from the example, which tries to read the file TestPage.md. Does that file exist in the same folder as the script? If not, then remove the Page block.
fincs
Windows 10 x64 Build 14393 / AutoHotkey v1.1.24.04
Get SciTE4AutoHotkey v3.0.06.01 - [My project list]
User avatar
fischgeek
Posts: 351
Joined: 29 Jan 2014, 21:39

Re: GenDocs - StdLib Documentation Generator

30 Jan 2014, 17:56

Where's the face slap emoticon? Oh well, this will do: :oops:
-_+
Posts: 70
Joined: 06 Dec 2014, 12:43

Re: GenDocs - StdLib Documentation Generator

06 Apr 2015, 00:51

fincs, that'd be nice, if you'd add some example of some script and the results of it's GenDoc parsing right here.
Also, why not write a module for ahk language for Doxygen?
Thanks for your script.

Return to “Scripts and Functions”

Who is online

Users browsing this forum: No registered users and 16 guests