Accessing SAS Component API Documentation :: SAS(R) AppDev Studio(TM) 4.4 Eclipse Plug-ins: User's Guide

Introduction

You can access the SAS Component API Javadoc from within Eclipse via the following:

the Eclipse Help system
context-sensitive Help in an Eclipse window (F1)
context-sensitive Help in an external browser (Shift+F2)

Eclipse Help System

To browse the SAS Component API documentation, follow these steps:

Select HelpHelp Contents.
Expand SAS Components Guide.
Expand Reference.

Context-Sensitive Javadoc in an Eclipse Window (F1)

To view the Javadoc for a class in an Eclipse window, place the text insertion point on a class name in the source code and press F1. A Help view appears in the workbench. The first link in the Help view is a link to the Javadoc, if Javadoc is available for the class.

The link in the Help view is context sensitive, and changes if you reposition the insertion point to a different class.

Context-Sensitive Javadoc in an External Browser (Shift+F2)

If the class is on the build path of the project, you can view the Javadoc for the class in an external browser by placing the insertion point on the class name in the source code and then pressing Shift+F2.

Configuring External Javadoc for Use within Eclipse

To specify more current documentation for a JAR file, or to add a reference to Javadoc for a third-party JAR file, follow these steps:

Open a project that uses the JAR file.
In the Package Explorer, expand SAS Repository.
Right-click on the JAR file with which you want to associate Javadoc and select Properties.
Select Javadoc Location and then specify the location.

Javadoc for SAS Components is not displayed when you position your mouse pointer over a class name or method call in the source code because the Javadoc for tooltips is generated from source code, and the SAS source code is not distributed.