tsdoc

NodeJS module for generate JSDoc Documentation from Typescript sources

Stats

StarsIssuesVersionUpdatedCreatedSize
tsdoc
44150.0.49 years ago9 years agoMinified + gzip package size for tsdoc in KB

Readme

#TSDoc#

A JSDoc3 base themed generator generator for use with Typescript Projects, uses a highly modified version Docstrap JsDoc3 Template.

Actually it only supports parsing of plain comments, also it needs some added "manual" anotation. @see docs for more info.

Instalation

sudo npm install tsdoc -g

Preparing your project

###Configuration###

TSDoc uses the same conf.json (now tsdoc.json) config file used in JsDoc3, but adds the following new options:

Adding a default tsdoc.json file

You can automatically add a new tsdoc.json file to any folder in yor system, typing in your console:

$> tsdoc -i

Command line options

$> tsdoc -i [--install] 
This will install the necesary tsdoc files to the current working directory.

$> tsdoc -s [--source]
Overrides tsdoc.json source folder settings.

$> tsdoc -d [--destination]
Overrides tsdoc.json destination settings.

License

Copyright (c) 2013 Pedro Casaubon aka xperiments. All rights reserved.

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.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.