Recently I developed a small tool in NodeJS which allows you to target a public GitHub repository and extract documentation from all the files it contains, assuming the documentation is Javadoc style. For those of you who don't know, Javadoc is the one that looks like this:
/** * Adds a turkey to the scene. * @param turkey The turkey to add to the scene. * @return True if successful, otherwise false. */ public function addTurkey(turkey:Turkey):Boolean
To use it, all you nee to do (after you install node, yada yada...) is extract the files and run
pulldoc.js in node - like this:
$ node pulldoc martywallace sentinel
The app will fetch your GitHub repository tree, find any files it considers relevant, then parses any docs that it finds within those files. Once that's done you will end up with a JSON file in
I'm pretty proud of how well it turned out, so much so that I might even make a small PHP application that consumes the output and generates a really basic class reference from it. It currently only supports consuming ActionScript 3 files, but I intend to add more languages like PHP.
You can check it out on GitHub.