I tried using the Javadocs recently to figure out how a certain component works. I find that Javadocs are a dissapointment in general. There is one significant thing that is lacking ....
The front page of Javadocs is the package index. There are 84 packages in Cocoon and only 6 of them have the brief package description. This description is very simply achieved ... add a "package.html" document to each directory under src/java/org/apache/cocoon These are other tasks to be added to the "To Do" list for the general documentation project ... ---------- * Add basic package.html for every package - as a template use components/search/package.html - minimum content is a h1 heading - this task is urgent (Cocoon image would be suffering) - need to decide optimal length of headings * Enhance each package.html - add a very concise description, using <p> etc. This is used for the Description section of each package's front page. * Link to other relevant Cocoon documentation - this is tricky - how to achieve both website and local doco - the "management of links" would be nice to automate * Review Javadoc comments inside each *.java - big - ensure consistency and ensure at least minimal content ---------- --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, email: [EMAIL PROTECTED]
