PDA

View Full Version : Javadocs help


Chronos_Gear
March 29th, 2006, 06:01 PM
Does anyone know where I might be able to find a complete version of the javadocs (http://www.limewire.org/nightly/javadocs/index.html) that I can easily download? I would appreciate it a lot.

Zootella
March 30th, 2006, 02:58 PM
Hi Chronos_Gear,

We don't have all the HTML files of our Javadocs zipped up somewhere. You could:

Use your favorite site scraping program to batch download them all
Download the source code, and read the Javadocs there
Use it from the Web site

Our Javadoc is great to understand exactly what a class does, but is less helpful when it comes to the interactions between the classes. That's what our wiki (http://www.limewire.org/wiki) will be for - but our wiki is just getting started.

anthikos
April 19th, 2006, 10:23 AM
Can I ask something relative, which might interest a lot of people?

It says somewhere that "good documentation already exists in the source code". Does this mean that there are Javadocs in source? apparently not huh? But if it exists where I can find them in the source? Thank you!

Sam
April 19th, 2006, 02:19 PM
The source code itself is documented with comments. That is what the phrase means.

Zootella
April 25th, 2006, 12:17 AM
The Javadoc HTML files are generated from comments in the source code. So, if you have the source code, you have all the Javadoc information and way more. The Javadoc Web site is really important for closed-source projects (not LimeWire) where you have only that, not the code.

The best way to experience LimeWire's Javadoc is in the code, in Eclipse. Follow these steps:
http://www.limewire.org/wiki/index.php?title=Program.GettingStarted

In Eclipse, the comments that become Javadoc will be blue, while regular comments are green.