Introduction

jsdoctk-plugin aims simply to create a Mojo around JsDoc Toolkit so that you can run it from within maven. Inside the plugins' jar is a packaged version of JsDoc Toolkit which gets temporarily unpacked into your target directory and is then used to run JsDoc Toolkit on your webapp directory. As a result you can now, easily and without a hassle, create documentation for your javascripts within a maven project...

Progress

A new version based on the JsDoc Toolkit 2.3.2 is finally released. I've not done a lot of polishing, just upgraded it to the latest toolkit release and introduced a feature which was requested by two users, in slightly different ways. Documentation has not been redone so much, so hopefully it's still 'good enough'.

For those not familiar with the changes in 2.x of JsDoc Toolkit I would give you an advance warning, the templates have changed significantly and this may, or may not be to your liking. I have no control over this!!! For this reasons alone I will keep the 1.x versions available for download, but support may grow even weaker than it has been so far ;).

Downloads

For people new with this plugin I recommend downloading the .zip distribution as I have added a usefull README as well as the 'JavaDoc' for the jar with more detailed information. If you're sure of what you're doing and just looking for the latest version go ahead and download the .jar, it saves only a little in size though :).

Alternatively, even though this keeps me from being able to track the popularity of this project, you can now specify a repository in your pom.xml like so:

    <repositories>
        <repository>
            <id>jsdoctk1</id>
            <url>http://jsdoctk-plugin.googlecode.com/svn/repo</url>
        </repository>
    </repositories>
    <pluginRepositories>
        <pluginRepository>
            <id>jsdoctk2</id>
            <url>http://jsdoctk-plugin.googlecode.com/svn/repo</url>
        </pluginRepository>
    </pluginRepositories>

Configuration

Installation Instructions as well as detailed Configuration Instructions are also available online. While previously I was mostly focused on keeping the packaged documentation up to date I've noticed the benefit of online collaboration (even if it's simply comments pointing out flaws in the documentation) and have shifted my efforts to the online documentation. Also, due to the addition of using wagon-svn for releasing new versions directly to a svn maven repository, I will most likely stop releasing downloads, relying entirely on the repository.