Tag Archives: jar

Adding javadoc to JAR files in a Netbeans project

The other day I was working on a Netbeans project where I had to create a new module that was dependent on a external JAR file. From the platform document I found out that you can add a JAR file in two ways: Using the Library Manager or using a Library Wrapper Module. First I tried the second option, and it worked fine except for one thing – there was no javadoc attached to the jar, and no way to attach it.

Project Properties
There is no way to edit the jar file properties

Then I tried the other option, adding the JAR as a library using the Libraries option from the Tools menu. Using this method it was possible to add both the javadoc and the source to the library. Unfortunately there was no way to include the library in a project, which kind of renders the whole ting useless. I still don’t know what the Library Manager is supposed to be used for, but apparently not for including JARs in projects.

After Googling for a while, coming up blank on what to do, I got in touch with a Netbeans expert Andrzej Olszak – author of the cool Featureous tool. He already knew the problem from his own work and also knew a work-around:

  1. Select the main module suite, click the New Project… option in the file menu and add a new Library Wrapper Module
  2. Select the JAR file to be included and complete the forms as needed. When you press OK, the new module should be opened along with your other modules.
  3. Right click on the module in the list of projects and select Properties at the bottom of the menu. Select the Libraries node on the left side, and click on the Wrapped JARs tab to the right.
  4. Now you see the same options as on the image above, with the Edit… button disabled. Here comes the trick:
  5. Select the JAR and press Remove, then press the Add JAR button and re-add the same JAR file again… and watch what happens to the Edit… button. Suddenly it is enabled! That is it…

Now you can include the wrapper module as a dependency in any module you like, and the javadoc will be available.

Javadoc for an included JAR file in Netbeans
Now the javadoc is visible...