Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Generates HTML pages of API documentation from JavaScript source files.
Java JavaScript
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
src
.gitignore
.travis.yml
LICENSE.md
README.md
TODO.txt
pom.xml

README.md

JaSDoc

JaSDoc generates JSDoc API documentation from your JavaScript source code. It is a platform-independent command-line application written in Java providing the following notable features:

Attention! JaSDoc is currently in an early alpha stage and only supports well-formed JavaScript code like Google's Closure Library for example. Any code which dynamically creates functions or classes during runtime is not supported yet. So if your code needs special tags like @borrows, @constructs, @field, @function, @inner, @lends, @name, @property or @static to tell the documentation tool how your code is structured then it won't work with JaSDoc yet.

Download

The latest release of JaSDoc can always be found in source form or in binary form at GitHub:

http://github.com/kayahr/jasdoc

Installation

Simply extract the downloaded binary ZIP file wherever you like and then you can run jasdoc in this directory without doing any more magic. It is recommended to change the PATH environment variable of your system to include the directory where you installed JaSDoc so you can run jasdoc from the command-line without specifying the installation directory.

Requirements

JaSDoc is written in Java and requires the Java Runtime Environment version 6 or higher. JaSDoc works fine with Oracle Java and OpenJDK.

Usage

Run jasdoc --help to display a short usage information. To generate an actual API documentation you just have to specify the JavaScript files or folders which are scanned recursively for JavaScript files:

jasdoc /some/source/folder

The HTML output is written to the directory out in the current working directory. You can change the output directory with the -d option:

jasdoc -d /tmp/apidoc /some/source/folder

Donation

If you like JaSDoc, please consider making a small donation to support my work on free software like this. Thank you!

Donate for JaSDoc

Build from source

If you prefer compiling JaSDoc yourself then you need the Java Development Kit version 6 or higher, Maven version 3 or higher and Git. If these tools are installed correctly then you can clone the JaSDoc source code from GitHub and compile it with these commands:

git clone https://github.com/kayahr/jasdoc.git
cd jasdoc
mvn package

When compilation was successful then the binary ZIP file can be found in the target directory. Compilation may take several minutes on the first run because Maven must download tons of dependencies. So please be patient.

Thanks to Maven JaSDoc can be easily imported into Java IDEs like Eclipse (With m2e plugin), NetBeans IDE and IntelliJ IDEA.

Report bugs

JaSDoc is pretty new and may still contain dozens of bugs. And JavaScript is a flexible language allowing many different coding strategies which may confuse JaSDoc. If JaSDoc doesn't work with your JavaScript code or you found any other kind of problem then please file an issue. If possible attach an example of your code which isn't handled correctly by JaSDoc.

License

Copyright (C) 2012 Klaus Reimer k@ailis.de

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

Something went wrong with that request. Please try again.