0.0.5 • Published 10 years ago

doccy v0.0.5

Weekly downloads
1
License
-
Repository
github
Last release
10 years ago

Doccy

Automatic generation of documentation READMEs.

Example

Given a test file:

/* DOC
 * @name foo
 * @param x does something
 * @returns a number
 */
var foo = function(x) {
    return 42;
};

Running:

$ doccy test.js test.md

Will create test.md that looks like so:

### `foo`

Parameters:

- `x`: does something

**Returns:** a number
0.0.5

10 years ago

0.0.4

10 years ago

0.0.3

10 years ago

0.0.2

10 years ago

0.0.1

10 years ago