You can now upload your API on your own with the JDocs Maven Plugin. The plugin is available at
the following repository location: http://www.jdocs.com/maven-repo.
Include the following entry in your pom.xml:
To use the plugin, add the following (or change your existing javadoc entry):
Your output will be a file javadoc.jdocs. Upload this file here If you haven't registered to be able to upload the API, register here.
<pluginRepositories>
<pluginRepository>
<id>www.jdocs.com</id>
<url>http://www.jdocs.com/maven-repo/</url>
</pluginRepository>
</pluginRepositories>
To use the plugin, add the following (or change your existing javadoc entry):
<reporting>
<plugins>
<plugin>
<groupId>com.dzone.jdocs</groupId>
<artifactId>javadoc</artifactId>
<version>1.0</version>
<configuration>
<aggregate>true</aggregate>
<source>1.5</source>
<overview>${basedir}/src/main/javadoc/overview.html</overview>
<groups>
<group>
<title>Group 1 Name</title>
<packages>org.package.pk1.*</packages>
</group>
<group>
<title>Group 2 name</title>
<packages>org.package.pkg2.*</packages>
</group>
<group>
<title>Group 3 name</title>
<packages>org.package.pkg3.*</packages>
</group>
</groups>
</configuration>
</plugin>
</plugins>
</reporting>
Run maven as: mvn com.dzone.jdocs:javadoc:1.0:javadoc Your output will be a file javadoc.jdocs. Upload this file here If you haven't registered to be able to upload the API, register here.
Attributes supported by the jdocs task
- includeSource: (default: true) - set to false to not include source code in the upload output
- overview: You must set the overview attribute to a file (typically overview.html in the root of the java classes) that describes the API. jdocs will use this to create the description of your API. Standard HTML tags are supported. Please refer to Sun doclet documentation for more details on the use of the overview attribute.
- forkJVM: (default false) Set to true to launch jdocs doclet in separate JVM process
Attributes of javadoc that are ignored by jdocs
To impose uniformity in the uploaded APIs, some attributes are
ignored by the jdocs doclet. These are:
- source: Expects compatibility with jdk 1.5 and higher.
- visibility: Always protected
- link: ignored
- version: Always set to true
- author: Always set to true
- doctitle: Ignored
- windowtitle: Ignored
- header: Ignored
- bottom: Ignored





