Introduction

The  API Documentation (APIDoc) is an HTML-based report of all Intershop 7 artifacts of a given version. It closes the gap between the existing Javadoc and the undocumented Intershop artifacts.

Layout and Usage

Main objective was to provide the same experience as using a regular Javadoc.

Usage

As the report closely resembles a Javadoc it can be navigated the same way. However, there are some differences to consider when using the APIDoc:

The APIDoc does not create details pages for Java types, instead it embeds their corresponding Javadoc pages. The following Javadoc sources are considered:

• For types from IS7 cartridges: the Javadoc of the corresponding cartridge
• For standard Java types: the official Java 7 SE documentation

It might be possible to consider third party libraries. If no Javadoc exists a "page not found" message will be displayed in the right pane.

Creation

Intershop Studio UI

To create an APIDoc in Intershop Studio:

option #1	Select the cartridges in the Cartridge Explorer. Invoke context menu. Select Export | Cartridge API...
option #2	Navigate to  File | Export...
	Select Cartridge API model, Documentation ...
	Select/deselect cartridges. Click  Next >.
	Select Generate API HTML Documentation. Click Next >.
	Enter an output location. Click Finish.
	either: Navigate to the output location and open index.html. Open the Progress view and click on the link.

Command-line Application

use ID: api.export.doc