Using Javadoc With Code Completion

See Also

You can browse Javadoc documentation at the same time you are using the code completion feature.

By default, a Javadoc box appears above or below the code completion box when you are completing Java expressions.

For the Javadoc documentation to display while you are using Java code completion, you must have the sources for the classes mounted as a filesystem. For information on mounting filesystems, see:

Mounting a Filesystem

To see documentation for Java SDK classes, you must have the Java SDK sources mounted. If you are running version 1.4 of the J2SE platform, the IDE mounts the SDK sources automatically the first time you use code completion on a JDK class. For information on mounting Java SDK sources, see:

Mounting the Java 2 SDK
Note If you have separate filesystems mounted for the source files and the class files, make sure the filesystem that contains the sources appears above the filesystem that contains the classes. Otherwise, the Javadoc will not be displayed during code completion. See:
Changing the Mount Order of Filesystems

If you have the class's compiled Javadoc mounted in the Javadoc Manager, you can browse the Javadoc in a web browser by clicking the Show Javadoc in external web browser button. See:

Adding a Javadoc Library to a Project
Note Different mechanisms are used to display Javadoc in the code completion Javadoc box and in the web browser. Therefore, the Javadoc may be viewable in one place and not the other. The Javadoc box that appears when you use code completion derives its documentation from mounted sources. When you search Javadoc with a web browser, the Javadoc is derived from compiled Javadoc files that are mounted in the Javadoc Manager.

For information on using the Javadoc box that appears when you use Java code completion, see:

Code Completion Javadoc Box
See Also
Completing a Java Expression
Setting the Completion Box Delay
Disabling Automatic Completion
Setting Code Completion Shortcuts

Legal Notices