csdoc

An API documentation generator for CoffeeScript.

npm install csdoc
1 downloads in the last day
5 downloads in the last week
21 downloads in the last month

CSDoc Dependency Status NPM version Build Status

An API documentation generator for CoffeeScript inspired by JSDoc. Project is work in progress.

Contribution is welcome.

Live Example of node-mssql documentation.

Installation

sudo npm install -g csdoc

Quick Examples

$ csdoc ./src
$ csdoc <script.coffee
$ csdoc <script.coffee >docs.json
$ csdoc --template html --dep mdn ./src

Usage

###
This is a class description.

@property {String} hair Model's hair.
###

class Model extends Object
    hair: "blonde"

    ###
    This is a constructor description.

    @param {String} name Model name.
    ###

    constructor: (name) ->

Documentation

Complete documentation can be found on CSDoc wiki!

License

Copyright (c) 2013 Patrik Simek

The MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

npm loves you