- Rock-solid source code parsing based on Rhino.
- Supports complex type expressions, interfaces and enums as used by Google's Closure Compiler.
- Extensive HTML support in JSDoc comments thanks to JSoup.
- Supports themes using FreeMarker as template engine.
The latest release of JaSDoc can always be found in source form or in binary form at GitHub:
Simply extract the downloaded binary ZIP file wherever you like and then you
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
the command-line without specifying the installation directory.
JaSDoc is written in Java and requires the Java Runtime Environment version 6 or higher. JaSDoc works fine with Oracle Java and OpenJDK.
jasdoc --help to display a short usage information. To generate an
The HTML output is written to the directory
out in the current working
directory. You can change the output directory with the
jasdoc -d /tmp/apidoc /some/source/folder
If you like JaSDoc, please consider making a small donation to support my work on free software like this. Thank you!
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.
Copyright (C) 2012 Klaus Reimer email@example.com
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.