README

 ____
/\  _`\
\ \ \/\ \        ___         ___         ___         ___
 \ \ \ \ \      / __`\      /'___\      /'___\      / __`\
  \ \ \_\ \    /\ \ \ \    /\ \__/     /\ \__/     /\ \ \ \
   \ \____/    \ \____/    \ \____\    \ \____\    \ \____/
    \/___/      \/___/      \/____/     \/____/     \/___/


Docco is a quick-and-dirty, hundred-line-long, literate-programming-style
documentation generator. For more information, see:

- Current Repo: https://github.com/GerHobbelt/docco
- Original Repo: https://github.com/jashkenas/docco


Installation
------------

  sudo npm install -g gerhobbelt/docco


Usage
-----

Usage: docco [options] FILES

  Options:

    -h, --help                output usage information
    -V, --version             output the version number
    -l, --layout [layout]     choose a built-in layouts (parallel, linear)
    -c, --css [file]          use a custom css file
    -o, --output [path]       use a custom output path
    -t, --template [file]     use a custom .jst template
    -b, --blocks              parse block comments where available
    -m, --markdown            output markdown
    --marked [file]           use custom marked options
    -k, --keepext [file]      keep original file extension
    -i, --ignore [file]       ignore unsupported languages
    -e, --extension [ext]     use the given file extension for all inputs
    -L, --languages [file]    use a custom languages.json

---


For Docco Developers: Building and Testing
------------------------------------------

Install (on Ubuntu 12):

( as root )
    apt-get install coffeescript

( as user )
    npm install
( See also: https://github.com/harvesthq/chosen/issues/508 )
    cake.coffeescript build
    cake.coffeescript doc
    cake.coffeescript test


When you run
    cake.coffeescript install
you must make sure to install the commander package as well:
    npm install commander -g



For Docco Developers: Building and Testing (original, outdated info):
---------------------------------------------------------------------

    npm install -g coffee-script
    npm install -g commander
    npm install
    make



===================================================================

This fork supports JSDoc style comments and highlights declared parameters.

Example:

```
/**
 * @description Lolify someone's name
 * @param {String} name A person's name
 */
function lolify(name) {
   return 'OH HAI ' + name + ' KTHXBAI';
}
```