Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Eclipse Generate Javadoc Wizard: what is "Javadoc Command"?

I want to generate the javadocs for an open-source code-base I'm using. But I'm being asked for a "Javadoc Command" by the Eclipse Generate JavaDoc wizard and the help doesn't explain what this means. Is it wanting the path to the javadoc binary/jar or something else?

like image 827
Mr. Boy Avatar asked Jun 22 '10 09:06

Mr. Boy


People also ask

What is the javadoc Command in eclipse?

The javadoc command parses the declarations and documentation comments in a set of Java source files and produces a corresponding set of HTML pages that describe (by default) the public and protected classes, nested classes (but not anonymous inner classes), interfaces, constructors, methods, and fields.

How do I show javadoc in Eclipse?

To see the javadoc of a class having attached source in eclipse: select Window -> show view -> javadoc (or alt + shift + q, j). then in the javadoc view, right click -> open attached javadoc (or shift + F2), this will display the javadoc of the class in the internal browser of eclipse.

How do I open javadoc?

Select the desired package, class or method name, right-click and select Show Javadoc. This will launch your default web browser and navigate to the Javadoc for the selected item.


2 Answers

Yes, presumably it wants the path to the javadoc command line tool that comes with the JDK (in the bin directory, same as java and javac).

Eclipse should be able to find it automatically; are you perhaps running it on a JRE? That would explain the request.

like image 199
Michael Borgwardt Avatar answered Sep 18 '22 13:09

Michael Borgwardt


Yes, it is asking for the application/executable that is capable of creating Javadoc. There is a javadoc executable inside the jdk's bin folder.

like image 31
Andreas Dolk Avatar answered Sep 18 '22 13:09

Andreas Dolk