29

Can eclipse show the entire javadoc? i.e. all methods (and their descriptions), when i highlight an object reference?

for example, if I do System, it shows me

java.lang.System

The System class contains several useful class fields and methods. It cannot be instantiated.

Among the facilities provided by the System class are standard input, standard output, and error output streams; access to externally defined properties and environment variables; a means of loading files and libraries; and a utility method for quickly copying a portion of an array.

Since: JDK1.0

but that tells me very litte about what I can do with that. yes, I can use the intelligent dot completion, but that seems a bit cumbersome.

any pointers would be appreciated.

spotter
  • 1,178
  • 1
  • 9
  • 19
  • 1
    If you load source into the classpath you can F3 into the class and read the code. Not the same as Javadoc but partway there... – shonky linux user Aug 07 '12 at 07:10
  • 1
    or I could do "open attached javadoc in browser" (shift-f2), but that negates the value of havingthe javadoc separate from the editing environment (browser seems to open a tab in the editing area) – spotter Aug 07 '12 at 07:16

5 Answers5

45

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.

M. Abbas
  • 6,409
  • 4
  • 33
  • 46
13

In the source editor hover mouse over some method or class name.

Then press 

Shift-F2 (Open External Documentation)

Javadoc View will open the full documentation at the right position.

weberjn
  • 1,840
  • 20
  • 24
3

If you have source attached to the classes (Both Java & custom) then you can see it in the Outline view by pressing F3.

srivenky
  • 456
  • 2
  • 3
  • Haaa..i guess shonky linux user added his comment before i pressed submit. Ignore mine if it is duplicate.. – srivenky Aug 07 '12 at 07:21
3

What you need to do is to hover mouse over some in-built method or class that are using in your program.

Hold ctrl on your keyboard and click. Then eclipse asks you to attach source. click on 'attach source', browse for src.zip file after choosing 'EXTRENAL' file. or instead give path for extracted src folder under same ie external file attachment.

Next time you hover over an in-built class or method it shows a small description. To view entire javadoc for same, keep holding ctrl and click on it.

It worked for me.

Gwenc37
  • 2,064
  • 7
  • 18
  • 22
abc
  • 117
  • 2
  • 11
2

I know that this post is old. Nevertheless I would like to add a procedure for showing Javadoc in an easy way.

I use eclipse oxygen 4.7.1a which is an year 2017 build.

-> Just hover over any declaration/method/object/class and press F2 to focus and now at the bottom of the tooltip that appears, we can find icons/buttons that can take us to its Javadoc in browser or eclipse view.

shift+F2 directly opens the javadoc of the entity you are hovering over, in a browser in the eclipse.

For this method to work a javadoc needs to be attached to your source. See linking javadoc.

HariUserX
  • 1,341
  • 1
  • 9
  • 17