PawnDoc
From DevDracoBlue
PawnDoc
Version 0.1
The tool PawnDoc is a tool for the Pawn language similar to JavaDoc for Java. With pawndoc-comments in your pawn sourcecode you can generate documentation-html-files and even wiki-syntax! See dprop.inc.wiki.txt or dprop.inc.html as example (source .pwn).
Contents |
Example
/**
* Returns the value of a property
* @param string name Name of the property
* @return string Value of the property
* @see PropertyGet
* @see PropertyExists
* @ingroup property
*/
stock PropertyGet(name[]) {
new value[255];
getproperty(0, "", dprop_PRIVATE_hash(name), value);
strunpack(value,value);
return value;
}
Download
Latest Version of PawnDoc is 0.1 and can be found at the Download-Area of DracoBlue.net (pawndoc_0_1.zip).
Usage
The source file dprop.inc, is parsed to a html-formated page like dprop.inc.html and to wiki-format like in dprop.inc.wiki.txt.
To parse PawnDoc-statements in your pawn-file to wikisyntax and htmlfile you have to use:
pawndoc dprop.inc html"dprop.inc.html" wiki"dprop.inc.wiki.txt"
If you want to parse to html only, you use:
pawndoc dprop.inc html"dprop.inc.html"
