Enable AEM Javadoc Hints

Evgeniy Fitsner Software Engineer
2 min read
Enable AEM Javadoc Hints

Introduction

To get the most out of your IDE when developing for AEM, you should enable Javadoc hints. These provide inline API documentation, parameter descriptions, and usage examples directly in your editor.

Steps for IntelliJ IDEA

  1. Open Project Structure (shortcut on Windows: Ctrl + Alt + Shift + S, on macOS: Cmd + ;).

  2. Under Libraries, find the Uber JAR dependency you are using (for example, Maven: com.adobe.aem:uber-jar:apis:6.4.4).

  3. Click the plus icon with the Earth symbol to add documentation.

  4. Enter the Javadoc URL for your AEM version:

1
https://helpx.adobe.com/experience-manager/6-4/sites/developing/using/reference-materials/javadoc/index.html

Adjust the version number in the URL to match your AEM release.

  1. Click OK to save.

Using the Documentation

After configuration, you can view API documentation hints by pressing Ctrl + Q on Windows or F1 on macOS while your cursor is on any AEM API class or method.

Javadoc URLs by Version

AEM Version Javadoc URL
6.5 https://helpx.adobe.com/experience-manager/6-5/sites/developing/using/reference-materials/javadoc/index.html
6.4 https://helpx.adobe.com/experience-manager/6-4/sites/developing/using/reference-materials/javadoc/index.html
6.3 https://helpx.adobe.com/experience-manager/6-3/sites/developing/using/reference-materials/javadoc/index.html

Contents