I need guidence with creating a javadoc for a library

Question

4.50/5 (2 votes)

See more:

Hi all

I'm developing plugins for a Continuess Integration tool called Hudson and want to make use of javadocs for help about the libraries provided to write the plugins.

I'm using NetBeans. I only have *javadoc.jar, *src.jar and *core.jar files available. How would I go about generating a javadoc viewable from netbeans. Why do they provide me with a *javadoc.jar if one can't generate a html javadoc from it?

I might be sounding very confusing... I'm a bit hopeless at the mo and need so guidence please.

Thanks,

Posted 17-Feb-11 22:25pm

R. Erasmus

Add a Solution

2 solutions

Add a Solution

Add your solution here

Treat my content as plain text, not as HTML

Preview 0

…

Existing Members

Sign in to your account

...or Join us

Download, Vote, Comment, Publish.

Your Email
Password
Forgot your password?

Your Email
This email is in use. Do you need your password?
Optional Password

I have read and agree to the Terms of Service and Privacy Policy
Please subscribe me to the CodeProject newsletters

When answering a question please:

Read the question carefully.
Understand that English isn't everyone's first language so be lenient of bad spelling and grammar.
If a question is poorly phrased then either ask for clarification, ignore it, or edit the question and fix the problem. Insults are not welcome.
Don't tell someone to read the manual. Chances are they have and don't get it. Provide an answer or move on to the next question.

Let's work to help developers, not make them feel stupid.

This content, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Arndt Faulhaber · Accepted Answer · 2011-02-18T04:57:00

The Javadoc.jar is meant to be attached (as documentation) to the library - if you link it to the lib probably where you define your class-path (sorry I do not know how you can do it in NetBeans, since I use eclipse...), you will see the java-doc when your mouse hovers over one of the Classes/Methods from that lib.

Additionally the jar-Files are actually simply tar-files, which you can easily extract with a standard Zip-Program such as 7-zip. Extracted, you might actually receive the HTML-Doc you were looking for ;)

Cheers, Arndt

BillW33 · Accepted Answer · 2011-02-18T05:02:00

A javadoc cannot be generated from a .jar file, you can generate javadoc from a .java file.

Look here for instructions on how to do it: http://mindprod.com/jgloss/javadoc.html[^]

NetBeans specific info here:
http://edu.netbeans.org/quicktour/javadoc.html[^]

Instructional video here:
http://www.youtube.com/watch?v=UK_7XQZhhoA[^]

I need guidence with creating a javadoc for a library

2 solutions

Solution 1

Solution 2

Add your solution here

Preview 0