Configuring javadoc with eclipse

T

Thomas Fritsch

Sreenivas said:
Can anybody tell how to configure javadoc with eclipse?
Thanks in advance,
What kind of JavaDoc are you talking about?
(1) You want to use Sun's JavaDocs for the API classes?
(2) You want to generate JavaDocs for *your* sources?

If (1):
In Eclipse's package explorer right-click
on "JRE System Library - rt.jar",
select "Properties", go to tab "JavaDoc location",
enter the location of the JavaDoc (either "http://.....",
or preferably the location of your locally downloaded
giant javadoc-zip-file)

If (2):
From Eclipse's menu select "Project - Generate JavaDoc...",
Step through the wizard.
 
L

Lew

Thomas said:
(2) You want to generate JavaDocs for *your* sources?

From Eclipse's menu select "Project - Generate JavaDoc...",
Step through the wizard.

It's pretty important that you have written Javadoc comments into your source
code.

From time to time Sun has cheated and used Javadocs as a sort-of
pre-processor, with little things like /** @deprecated */ and /** @throws
RuntimeException */. Fortunately since annotations came out we've seen a move
away from that.

While I do say it's fortunate we've moved away from burying program semantics
in Javadoc comments, there is an argument in favor of that behavior, emanating
from the perception of Javadocs as a form of "literate programming".
 

Ask a Question

Want to reply to this thread or ask your own question?

You'll need to choose a username for the site, which only take a couple of moments. After that, you can post your question and our members will help you out.

Ask a Question

Members online

No members online now.

Forum statistics

Threads
473,755
Messages
2,569,536
Members
45,013
Latest member
KatriceSwa

Latest Threads

Top