[Martin Kersten wrote:] > How about changing: > > [snip] > The Release Notes document the new features and bug fixes that have been > included in this release. > > The JavaDoc API documents are available online. In particular, you should > read the package description for the org.apache.commons.digester package > for detailed information on using the package. > [snap] > > to: > > The Release Notes document the new features and bug fixes that have been > included in this release. > > The Documentation is part of the JavaDoc API documentation. In particular, > you should read the package description for the org.apache.commons.digester > package for detailed information on using the package. > > The JavaDoc API documents are also available online.
I think this is a good suggestion, so I have made some minor changes to the "index.xml" xdoc file. I don't have Maven installed, so rather than commit the change without having tested it, here is a patch that I hope some maven user can test & apply. > I would suggest the following to prevent another one falling some traps > I went through and wasted 4 hours of my life. Well not wasted entirely > but it wasn't that productive also. > > a) refactor the The JavaDoc API documentation is available... and > split it up and mention the documentation being part of the api in > first place. Sorry, I don't understand this. Refactor what and how? Split what up? > > b) alter the package documentation to reflect whats happening when > it comes to self containment. (tag contains itself as child, the information > was lagging). Can you provide a patch to the existing package.html file which includes the information you want? I will proof-read it for you. Thanks for your comments. Regards, Simon
Index: index.xml =================================================================== RCS file: /home/cvs/jakarta-commons/digester/xdocs/index.xml,v retrieving revision 1.6 diff -u -r1.6 index.xml --- index.xml 15 Feb 2004 11:21:43 -0000 1.6 +++ index.xml 29 Feb 2004 22:15:53 -0000 @@ -38,14 +38,23 @@ <section name="Documentation"> +<p>User documentation is available as package descriptions within the +<a href="http://jakarta.apache.org/commons/digester/api/index.html";>JavaDoc +API documents</a>. In particular, you should read the package description for +the <code>org.apache.commons.digester</code> package for detailed information +on using the package.</p> + <p>The <a href="http://jakarta.apache.org/commons/digester/RELEASE-NOTES.txt";> Release Notes</a> document the new features and bug fixes that have been included in this release.</p> -<p>The <a href="http://jakarta.apache.org/commons/digester/api/index.html";> -JavaDoc API documents</a> are available online. In particular, you should -read the package description for the <code>org.apache.commons.digester</code> -package for detailed information on using the package.</p> +<p>The "examples" directory in the CVS repository contains code which +demonstrates the basic functionality. In particular, you should read the +AddressBook example in the "api" subdirectory. You can view the examples +directly from the CVS repository via <a +href="http://cvs.apache.org/viewcvs.cgi/jakarta-commons/digester/src/examples/";> +the ViewCVS</a> web site, or can use CVS to download the files. +</p> </section>
--------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
