autodoc-gen

Introduction

I'm really lazy, this is known. I decided to create something that would automatically document my node functions for me. This is currently really touchy but it works for my uses.

Code Samples

     /**
     * @localmember processData
     * @description Search a string for a substring and return it's index if it exists. If not return -1. 
     * @param {string} str the string to search.
     * @param {string} subStr the substring to search from the string.
     * @param {int} overload to overload the index starting point.
     * @return {int} returning the index if the substring exists in string, if not then it will return -1.
     */

The interesting thing about this is that I added a new type descriptor which is the local member. It shows that if a function is within another function you can have it actually documented of the functions supposed parent.

Installation

Through NPM

$ npm install --save autodoc-gen

Through Github

$ git clone https://github.com/nicolsek/Autodoc-Generator.git
$ npm install

Now autodoc-gen is ready to be used! (Just like me in all of my relationships ;'( )

Usage

var autodocGen = require('autodoc-gen');
autodocGen();

$ node ./autodoc.js <PATH_TO_FILE> <OUTPUT.md> <OPTIONAL_FLAGS>

An example of this...

License

MIT © Nicole Tusek