Give javadoc utility some more memory to avoid OutOfMemoryErrors.

Some additional package description and better package grouping.
Handle @event.severity tag.

git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@732274 13f79535-47bb-0310-9956-ffa450edef68

6 files changed, 135 insertions, 5 deletions

diff --git a/build.xml b/build.xml
index 2d92b2e11..938bda4a8 100644
--- a/build.xml
+++ b/build.xml
@@ -988,7 +988,7 @@ NOTE:
     <property name="javadoc.level" value=""/>
     <echo message="Producing the javadoc files${javadoc.level}"/>
     <mkdir dir="${build.javadocs.dir}"/>
-    <javadoc packagenames="${javadoc.packages}" destdir="${build.javadocs.dir}" author="true" version="true" windowtitle="${Name} ${version} API" doctitle="Apache Formatting Objects Processor (FOP)" bottom="Copyright ${year} The Apache Software Foundation. All Rights Reserved." overview="${src.dir}/java/org/apache/fop/overview.html" use="true" failonerror="true" source="${javac.source}" public="${javadoc.public}" package="${javadoc.package}" private="${javadoc.private}">
+    <javadoc packagenames="${javadoc.packages}" destdir="${build.javadocs.dir}" author="true" version="true" windowtitle="${Name} ${version} API" doctitle="Apache Formatting Objects Processor (FOP)" bottom="Copyright ${year} The Apache Software Foundation. All Rights Reserved." overview="${src.dir}/java/org/apache/fop/overview.html" use="true" failonerror="true" source="${javac.source}" public="${javadoc.public}" package="${javadoc.package}" private="${javadoc.private}" maxmemory="128M">
       <header><![CDATA[${name} ${version}]]></header>
       <footer><![CDATA[${name} ${version}]]></footer>
       <classpath>
@@ -1001,6 +1001,7 @@ NOTE:
         <pathelement path="${build.gensrc.dir}"/>
       </sourcepath>
       <tag name="todo" scope="all" description="To do:"/>
+      <tag name="event.severity" scope="all" description="Event severity level:"/>
       <group title="Control and Startup">
         <package name="org.apache.fop"/>
         <package name="org.apache.fop.apps"/>
@@ -1032,17 +1033,31 @@ NOTE:
         <package name="org.apache.fop.render.rtf"/>
         <package name="org.apache.fop.render.mif"/>
       </group>
+      <group title="Fonts">
+        <package name="org.apache.fop.fonts"/>
+        <package name="org.apache.fop.fonts.*"/>
+      </group>
+      <group title="Events">
+        <package name="org.apache.fop.events"/>
+        <package name="org.apache.fop.events.*"/>
+      </group>
       <group title="Utility">
         <package name="org.apache.fop.hyphenation"/>
-        <package name="org.apache.fop.pdf"/>
         <package name="org.apache.fop.tools"/>
         <package name="org.apache.fop.tools.*"/>
-        <package name="org.apache.fop.svg"/>
         <package name="org.apache.fop.image"/>
         <package name="org.apache.fop.image.*"/>
-        <package name="org.apache.fop.fonts"/>
-        <package name="org.apache.fop.fonts.*"/>
+        <package name="org.apache.fop.text.*"/>
         <package name="org.apache.fop.util"/>
+        <package name="org.apache.fop.util.*"/>
+      </group>
+      <group title="AFP library">
+        <package name="org.apache.fop.afp"/>
+        <package name="org.apache.fop.afp.*"/>
+      </group>
+      <group title="PDF library">
+        <package name="org.apache.fop.pdf"/>
+        <package name="org.apache.fop.svg"/>
       </group>
       <group title="RTFLib (formerly JFor) Subpackage Candidate">
         <package name="org.apache.fop.render.rtf.rtflib"/>
diff --git a/src/java/org/apache/fop/events/model/package.html b/src/java/org/apache/fop/events/model/package.html
new file mode 100644
index 000000000..4d915721b
--- /dev/null
+++ b/src/java/org/apache/fop/events/model/package.html
@@ -0,0 +1,23 @@
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+<!-- $Id$ -->
+<HTML>
+<TITLE>org.apache.fop.events.model Package</TITLE>
+<BODY>
+<P>Model classes for the event subsystem.</P>
+</BODY>
+</HTML>
\ No newline at end of file
diff --git a/src/java/org/apache/fop/events/package.html b/src/java/org/apache/fop/events/package.html
new file mode 100644
index 000000000..d2e6d63de
--- /dev/null
+++ b/src/java/org/apache/fop/events/package.html
@@ -0,0 +1,23 @@
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+<!-- $Id$ -->
+<HTML>
+<TITLE>org.apache.fop.events Package</TITLE>
+<BODY>
+<P>Subsystem for reporting events inside FOP to client applications.</P>
+</BODY>
+</HTML>
\ No newline at end of file
diff --git a/src/java/org/apache/fop/fonts/substitute/package.html b/src/java/org/apache/fop/fonts/substitute/package.html
new file mode 100644
index 000000000..c144ca1f8
--- /dev/null
+++ b/src/java/org/apache/fop/fonts/substitute/package.html
@@ -0,0 +1,23 @@
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+<!-- $Id$ -->
+<HTML>
+<TITLE>org.apache.fop.fonts.substitute Package</TITLE>
+<BODY>
+<P>Font substitution facilities.</P>
+</BODY>
+</HTML>
\ No newline at end of file
diff --git a/src/java/org/apache/fop/text/linebreak/package.html b/src/java/org/apache/fop/text/linebreak/package.html
new file mode 100644
index 000000000..3eca305f0
--- /dev/null
+++ b/src/java/org/apache/fop/text/linebreak/package.html
@@ -0,0 +1,23 @@
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+<!-- $Id$ -->
+<HTML>
+<TITLE>org.apache.fop.text.linebreak Package</TITLE>
+<BODY>
+<P>Unicode linebreaking algorithm.</P>
+</BODY>
+</HTML>
\ No newline at end of file
diff --git a/src/java/org/apache/fop/util/text/package.html b/src/java/org/apache/fop/util/text/package.html
new file mode 100644
index 000000000..e8ba8044f
--- /dev/null
+++ b/src/java/org/apache/fop/util/text/package.html
@@ -0,0 +1,23 @@
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+<!-- $Id$ -->
+<HTML>
+<TITLE>org.apache.fop.util.text Package</TITLE>
+<BODY>
+<P>Message formatting classes.</P>
+</BODY>
+</HTML>
\ No newline at end of file