Javadocs for DXP Digital Enterprise, Liferay Portal CE, and apps

Whether you're new to developing on Liferay DXP Digital Enterprise 7.0 and Liferay Portal CE 7.0 or you've developed on previous versions of Liferay Portal, the latest additions and improvements to Liferay's reference docs are for you.

New additions and improvements:

  • Reference docs for DXP Digital Enterprise, DXP apps, and CE apps
  • Improved Javadoc organization and aggregation
  • Module info in app Javadoc
  • Accessible Javadoc archives

As background, reference docs for previous versions of Liferay Portal and its built-in apps were grouped together, mirroring the product's monolithic codebase. However, Digital Enterprise 7.0 and Liferay Portal CE 7.0 comprise a small core set of modules and no applications.Applications that were previously built into Liferay Portal are now independent applications or in separate application suites. The respective reference docs now accompany DXP Digital Enterprise, Liferay Portal CE, and their apps.

Here’s the new reference documentation hierarchy on https://docs.liferay.com:

 

The digital-enterprise and portal folders contain subfolders for their releases. Their 7.0-latest subfolders link to reference docs for the latest 7.0 releases.

 

Figure 1: The *latest folders link to the latest version folder for the product.

 

Every Digital Enterprise release folder and Portal CE release folder has the following types of reference docs:

  • Javadoc

  • Taglib docs

  • Properties file defaults and descriptions

  • DTD Definitions

Reference docs for DXP and CE applications and applications suites reside in the dxp/apps/ and ce/apps/ folders.

Javadoc for an app’s modules is conveniently aggregated. The Javadoc overview page groups packages by module and shows each module’s bundle symbolic name and version, for developers to copy into their dependency files (e.g., build.gradle or pom.xml files).

Group name: com.liferay applies to all Liferay modules.

Figure 2: An app's Javadoc contains Javadoc for all packages in all the app's modules. The overview groups packages by module and highlights the module name

Lastly, all product release folders have a downloadable Javadoc archive (ZIP or JAR) for developers to download and browse offline if needed.

Figure 3: Want to browse Javadoc offline? Download a Javadoc archive.

 

As always, thanks to everyone who has contributed and continues to contribute Liferay reference docs.

 

Coming soon:

  • Application Taglib docs

  • Reference docs for more applications (apps for Digital Enterprise 7.0 and Portal CE 7.0)

 

See also: