jsdocs

A doc generator, written in markdown for speed.

Installment

$ npm install jsdocs -g

Quick Start

$ jsdocs build ./src ./dist

User Guide

• Name

  • File name, e.g., index.json

• Type

  • Whether it is a synchronous or asynchronous request

• Request

  • Request Params including parameter type, e.g, string or boolean
  • * indicates compulsory

• Response

  • success: boolean type, indicates request is successful (true) or not (false)
  • errorCode: user defined error code, applies if request failed
  • data - array type
    • title: field name
    • content: field value

You may refer to index.md

License

The MIT License (MIT)

Copyright (c) 2013 xdf

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.