jendoc

0.1.1 • Public • Published

jendoc

jendoc - Javascript documentation generator

Principles

  • Easy templating
  • Beautiful default template
  • Tags compatible with JsDoc
  • Written in Javascript (Node.js, no JVM required)
  • Fast generation

Installation

To install from npm:

$ npm install jendoc

You will also need the templates folder. You can copy them from npm installation directory or download them from github:

$ wget https://github.com/downloads/kamibu/jendoc/templates.tar.gz
$ tar -xvzf templates.tar.gz

Tags supported

  • @class
  • @constructor
  • @param {Type} name
  • @type Type
  • @returns Type
  • @public
  • @private

Authors

Aleksis Brezas abresas@kamibu.com

License

(The MIT License)

Copyright (c) 2011 Kamibu

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 THEAUTHORS 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.

Readme

Keywords

none

Package Sidebar

Install

npm i jendoc

Weekly Downloads

0

Version

0.1.1

License

none

Last publish

Collaborators

  • abresas