Pulpcore and JavaDoc

One of the major personal love for Java is its JavaDoc description, it is extremely handy when you are coding something and is on a quest for the proper method to resolve your problems, especially when you are not extremely familiar with the library that you are using. However, upto the latest post I wrote on Pulpcore, we are still getting a screen that looks like this when we attempt to read the documentations within Netbeans.

Annoying isn’t it? We know there’s JavaDoc with Pulpcore, in fact, we can easily access it online! Don’t believe me? Click here for the Pulpcore 0.11.5 JavaDoc API!

So, how do we go about doing this? According to the original authors of the NetBeans Module, you need to add some jar files and a brunch of doc files to get this up and running, I’ve found a more simple and reasonable approach.

Code Assist JavaDocs from what I recall back from Java 1.4 is actually source code related. If you have your source code there, the engine will first attempt to look for the method or variables and display the JavaDoc style comments you have included with that method or variable.

Luckily, Pulpcore is released with Source, we can easily take advantage of this.

1. Navigate to your Pulpcore 0.11.5 folder and look for a zip file called ‘src.zip’ extract it to a sub folder called src.
2. At this point, if your Pulpcore 0.11.5 files are in C:\pulp, then you should have a sub folder called C:\pulp\src\.
3. Within C:\pulp\src, is a folder called src, and within this folder is a folder called pulpcore.
   
   You should have a file structure like C:\pulp\src\src\pulpcore\, if you don’t just look for the plupcore folder, the name of the parent folder of pulpcore is the one that you need to remember. For my example, it is C:\pulp\src\src.
4. Go back to Netbeans and navigate to the project properties.
   
5. Navigate to Java source Classpath
   
6. click on
   
7. Type in C:\pulp\src\src and click on open.
8. Click OK to save the Project Properties.
9. Test the Code assistant again.
   

You are done

Now, you are not only getting the live documentations from the Java code of Pulpcore 0.11.5, when you are running into problems during debugging, you can easily access the source code of the Pulpcore to find out whether you are using a method properly or not.

Tags: java, JavaDoc, JavaDoc description, JavaDoc style, Navigate, Netbeans, proper method, pulp, sub, zip