Documentation Template for Core Addons

(Edit page to see template code.)

ADDON_NAME

(choose one) This addon provides standalone functionality, and exports services for use in other addons.

This addon provides standalone functionality.

This addon exports services for use in other addons.

This addon provides classes for use in other addons.

This addon is a 'Furnace container' that provides lifecycle and service registry support for dependent addons.

Dependencies: None (or)

Depends on

Addon	Exported	Optional
DEP1	Yes	No
DEP2	Yes	Yes

Setup

This Addon requires the following installation steps.

Add configuration to pom.xml

To use this addon, you must add it as a dependency in the pom.xml of your forge-addon classified artifact:

      <dependency>
         <groupId>ADDON_GROUP_ID</groupId>
         <artifactId>ADDON_ARTIFACT_ID</artifactId>
         <classifier>forge-addon</classifier>
         <version>${version}</version>
      </dependency>

Features

Creating a new ABC instance

Allows for blah blah

ABC abc = factory.createABC();

Creating a new XYZ instance

Causes XYZ to occur

XYZ xyz = factory.createXYZ();