GenDocs - StdLib Documentation Generator

[fincs]

[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

[fischgeek]

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

/*!
	Library: Test library, version 1.0
	Author: fincs
	License: WTFPL
*/

/*!
	Page: Test Page
	Filename: TestPage
	Contents: @file:TestPage.md
*/

/*!
	Function: something(a, b [, c])
		something() does something :)

	Parameters:
		a - Something
		    > MsgBox Yay, this works?! ; comment!
		b - Something else
		c - (Optional) Even more stuff

	Remarks:
		Meow.

	Returns:
		Dinner, really :)

	Extra:
		### It looks like everybody's been taken to Tykogi Tower!
		Oh, my!

	Throws:
		Stuff if stuff
*/

myTest(a,b,c) {
	return "This is a test"
}

[fincs]

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.

[fischgeek]

Where's the face slap emoticon? Oh well, this will do:

[-_+]

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.