Displaying Javadoc Content in Eclipse for the Azure Libraries Package for Java

The Javadoc content for the Azure Libraries for Java can be viewed within your Eclipse environment by associating the Javadoc content to the Azure Libraries for Java. The following steps show you how to use this functionality within Eclipse.

This procedure assumes you have already added the Azure Library for Java to your build path.

To display Javadoc content in Eclipse for the Azure Libraries for Java

  1. Within Eclipse's Project Explorer, in the Referenced Libraries section of your project, open the context menu for the Azure Library for Java JAR. For example, microsoft-windowsazure-api-0.1.0.jar (the version number may be different, dependent upon which version you have installed).

  2. Click Properties.

  3. Within the Properties dialog, in the left-hand pane, click Javadoc Location. The Javadoc Location dialog is displayed.

  4. You can specify a Javadoc URL, or a Javadoc in archive.

    Make your choice and browse/validate as needed. The following example associates the Azure Libraries for Java with the corresponding Javadoc JAR that has been downloaded locally to a folder named c:\MyAzureJARs.

    Display Javadoc content.

  5. Optional Step: Click Validate. Potential issues with the Javadoc JAR could be displayed here.

  6. Click OK.

Once associated with the library, the Javadoc content should display within your Eclipse IDE. For example, if blob is defined of type CloudBlockBlob within your code, the following is an example of Javadoc content that appears when you type blob.acquireLease in code:

Display Javadoc content.

Next steps

To report bugs or request new features, create issues on our GitHub repository. Or, ask questions on Stack Overflow with tag azure-java-tools.

For more information about using Java with Azure, see the following links: