Scribd
Upload
58 views

FOP Development: API Documentation (Javadocs) : $revision: 627324 $

This document provides information on accessing and building API documentation (javadocs) for the Apache FOP project. It outlines how to access javadocs online through builds done by Apache Gump or how to build the javadocs yourself from the source code. Building the javadocs yourself will generate documentation targeted to a specific release rather than the current development code.

Uploaded by

cancelthis0035994
Copyright
© Attribution Non-Commercial (BY-NC)
Available Formats
Download as PDF, TXT or read online on Scribd
58 views

FOP Development: API Documentation (Javadocs) : $revision: 627324 $

This document provides information on accessing and building API documentation (javadocs) for the Apache FOP project. It outlines how to access javadocs online through builds done by Apache Gump or how to build the javadocs yourself from the source code. Building the javadocs yourself will generate documentation targeted to a specific release rather than the current development code.

Uploaded by

cancelthis0035994
Copyright
© Attribution Non-Commercial (BY-NC)
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 2

FOP Development: API Documentation (javadocs)

$Revision: 627324 $

Table of contents
1 2

On-line Access (through Gump).......................................................................................................... 2 Building them Yourself........................................................................................................................2

PDF created by Apache FOP http://xmlgraphics.apache.org/fop/

FOP Development: API Documentation (javadocs)

1. On-line Access (through Gump)


FOP (and many other Apache projects) use Apache Gump to do a test build several times each day. One of the useful byproducts of this process is that javadocs can be created and made available. First, determine which line of development code you wish to see. If you don't know, you probably want the "Maintenance Branch", which is the line that currently produces FOP releases. See Development Lines for more details.
Warning:
Javadocs for both development lines are made from current SVN code, and are not tied to any particular release. Both the documentation and the API may be different, even if you are working with the correct branch. Currently, the only way to obtain API documentation for a specific release is to build it yourself.

Javadocs for Maintenance Branch Javadocs for Trunk (Redesign)


Note:
If the links return an "Object not found!" message or otherwise do not work properly, it is probably because of a build error. Please raise a question on the FOP User Mailing List so that any problems can be fixed before the next build.

2. Building them Yourself


See Source Download for instructions on obtaining the source code. Then see Building FOP for instructions on running the build process. The Ant build target that you will use to generate the API documentation is "javadocs", and the results will be stored in xml-fop/build/javadocs.

PDF created by Apache FOP http://xmlgraphics.apache.org/fop/

You might also like