From efeb7948e8b7319d87d67b9ed5c2304ce434baee Mon Sep 17 00:00:00 2001 From: William Victor Mote Date: Mon, 5 May 2003 18:57:02 +0000 Subject: [PATCH] Add API doc. git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@196400 13f79535-47bb-0310-9956-ffa450edef68 --- .../content/xdocs/dev/api-doc.xml | 25 +++++++++++++++++++ src/documentation/content/xdocs/dev/book.xml | 1 + 2 files changed, 26 insertions(+) create mode 100644 src/documentation/content/xdocs/dev/api-doc.xml diff --git a/src/documentation/content/xdocs/dev/api-doc.xml b/src/documentation/content/xdocs/dev/api-doc.xml new file mode 100644 index 000000000..4c06c0a09 --- /dev/null +++ b/src/documentation/content/xdocs/dev/api-doc.xml @@ -0,0 +1,25 @@ + + + +
+ FOP API Documentation (javadocs) +
+ +
+ 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.

+ Javadocs for both development lines are made from current CVS 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)
    • +
+ 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. +
+
+ 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.

+
+ + diff --git a/src/documentation/content/xdocs/dev/book.xml b/src/documentation/content/xdocs/dev/book.xml index 46825bf59..7d0935549 100644 --- a/src/documentation/content/xdocs/dev/book.xml +++ b/src/documentation/content/xdocs/dev/book.xml @@ -18,6 +18,7 @@ + -- 2.39.5