Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
CommonJS based javascript documentation generator
JavaScript
Pull request Compare This branch is 38 commits behind master.

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
bin
engines
lib
templates/dark-pastels
tests
README.md
package.json

README.md

JSDocs is javascript documentation generator written in JavaScript (Under Development)

JSDocs is a port of jsdoc-toolkit. The main goal of the project is to decouple it from Rhino and use Narwhal, the JavaScript standard library conforming to the ServerJS standard instead. It will provide a simple way for server-side Javascript environments to generate documentation without any deployment costs or dependencies on other libraries or runtimes. JSDocs will be available as standard JavaScript packages jspkg, which will make it easy to install/deploy it using getjs or whichever will be the standard JavaScript package management system. The project hopes to get as much external collaboration as possible, in order to have a powerful cross platform documentation tool.

Current state

Currently the project is under development and it is not heavily tested, but seems to be working. The code ported from jsdocs-toolkit is very messy and it was not designed for modular systems conforming Securable Modules specification, therefore a major refactoring still has to be done. The template system is likely to be changed as it is really tied to the model now. Everyone is more than welcome to help with it!

Demo pages

documentation source

Getting Started

The current implementation uses Narwhal. Narwhal is a JavaScript Standard Library (based on the ServerJS standard: https://wiki.mozilla.org/ServerJS) and is located at http://github.com/tlrobinson/narwhal/

To start working with JSDoc, checkout the Narhwal and JSDoc repositories and add narwhal/bin to your PATH environment variable (e.x. "export PATH=$PATH:narwhal/bin"). Currently you need to use relative path symlinks to integrate with Narwhal.

  1. cd narwhal/packages/ ln -s ../../jsdocs jsdocs

  2. cd ../bin ln -s ../../jsdocs/bin/jsocs jsdocs

After that you should be able to run tool by typing:

jsdocs -t jsdocs/templates/jsdoc/ bespinserv/lib/

-t points to the folder with template to be used. In the root of the repository you can find the templates/ folder with a jsdoc/ subfolder. Thats an example of a template (jsdoc-toolkit templates are not compatible). The second argument is the path to folder containing sources that will be documented.

For more additional info run:

jsdocs --help

Contributors

  • Irakli Gozalishvili

Some portions of code in this software is used with permission from JsDoc Toolkit. JsDoc Toolkit is Copyright (c)2009 Michael Mathews micmath@gmail.com

JsDoc Toolkit is free software; you can redistribute it and/or modify it under the terms below:

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

Something went wrong with that request. Please try again.