[Geotools-commits] svn - r17427 - geotools/trunk/gt

[<des...@sv...>]

Author: desruisseaux
Date: 2005-12-26 00:02:50 -0800 (Mon, 26 Dec 2005)
New Revision: 17427

Modified:
   geotools/trunk/gt/build-javadoc.xml
Log:
Added 'Running the script' instructions.

Modified: geotools/trunk/gt/build-javadoc.xml
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- geotools/trunk/gt/build-javadoc.xml	2005-12-26 07:31:20 UTC (rev 1742=
6)
+++ geotools/trunk/gt/build-javadoc.xml	2005-12-26 08:02:50 UTC (rev 1742=
7)
@@ -8,12 +8,22 @@
      file. This script exists because creating a cross-module javadoc
      throws an OutOfMemoryError with Maven 1, and is not yet supported
      in Maven 2.
-    =20
+
      It is recommanded (but not essential) to do a Maven 2 build before
      to run this script, using the "mvn install" command line in the sam=
e
      directory. It will avoid many javadoc warnings, because most classe=
s
      information will be available to javadoc in the 'target' directory.
=20
+
+     =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
+     RUNNING THE SCRIPT
+     =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
+     Just type the following on the command line
+     (the first line is optional; see above paragraph):
+
+         mvn install
+         ant -f build-javadoc.xml
+
      By default, this script put the generated HTML pages in the
      'target/javadoc' directory. To select a different directory,
      add a 'build-javadoc.properties' file in the same directory