Here is a patch that adds an overview to the javadoc for the pool
package. It attempts to show how one would use the component to pool a
particular object in a very simple way.
I also noticed that the text of pool/package.html is copied into an
xdoc, with some notes that it be used as a starting point. I think it
is better to remove the duplication and just have the xdoc link to the
javadoc. If there is anything better to be said, it should be done in
one location. As the pool package is not complex, the javadoc is enough
documentation to make the package useful.
Note: I put the overview.html next to commons/pool/package.html.
john mcnally
Index: build.xml
===================================================================
RCS file: /home/cvspublic/jakarta-commons/pool/build.xml,v
retrieving revision 1.5
diff -u -r1.5 build.xml
--- build.xml 15 Jan 2002 01:20:52 -0000 1.5
+++ build.xml 5 Apr 2002 17:13:46 -0000
@@ -153,7 +153,8 @@
destdir="${dest.doc.api}"
windowtitle="${Name-Long}"
doctitle="${Name-Long}"
- bottom="<small>Copyright &copy; 2001 Apache Software
Foundation. Documenation generated ${TODAY}</small>."
+ bottom="<small>Copyright &copy; 2001 Apache Software
+Foundation. Documentation generated ${TODAY}</small>."
+ Overview="${workdir}/org/apache/commons/pool/overview.html"
public="true"
version="true"
author="true"
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
