Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Each layer only invokes the layer below it; the application layer may not used use the storage layer directly, for example. Each component in the storage and business logic layers has a defined public API. The union of the APIs of those components are referred to as the Storage API (in the case of the storage layer) and the DSpace Public API (in the case of the business logic layer). These APIs are in-process Java classes, objects and methods.

...

Wiki Markup
The storage and business logic layer APIs are extensively documented with Javadoc-style comments. Generate the HTML version of these by entering the \[DSDOC:dspace-source\]/dspace directory and running:

...

Wiki Markup
The resulting documentation will be at _\[DSDOC:dspace-source\]dspace-api/target/site/apidocs/index.html_.  The package-level documentation of each package usually contains an overview of the package and some example usage. This information is not repeated in this architecture document; this and the Javadoc APIs are intended to be used in parallel.

...