Generate JavaDoc for plugin

Openfire Openfire Dev
1

Hi,

my plugin has currently 4200 lines of code in 26 sourcefiles. So it would be helpful to generate JavaDoc pages for my project.

Currently I’'am using a simple bash script:

#! /bin/bash
cd ~/openfire/openfire_helga_3_3_2
javadoc -private -version -author \
     -d /home/coolcat/openfire/javadoc_helga/html \
     -sourcepath src/java:src/plugins/helga/src/java \
     org.jivesoftware.openfire.plugin org.jivesoftware.openfire.plugin.helga

Because I don’'t have (and want) the org.dom4j sourcecode, I get hundreds of warnings like this:

/home/coolcat/openfire/openfire_helga_3_3_2/src/java/org/jivesoftware/openfire/container/PluginManager.java:14: package org.dom4j does not exist
import org.dom4j.Attribute;

Is there any way to suppress this warnings, so I can find/read the important warnings?

Coolcat

2

It took a while, but I found a solution for this. We simply need to include all JAR files that openfire uses.

Assuming we are in openfire source directory (as above) and we are on a Linux/Unix just add the following:

#! /bin/bash ... JDOC_LIB=`find build/lib/* -name "*.jar" -printf "%p:"`; javadoc ......... -classpath $JDOC_LIB .........

If our plugin does use additional libraries, we have to add them, too.

P.S: This can be moved to Community Plugins