> Bertrand Delacretaz wrote: >> David Crossley wrote: >> >. . . >> > I wonder if we can extract some minimal information from >> > javadoc tags and supplement that with an xml fragment in >> > an accompanying file, to build a -manpage.xml >> >. . . >> >> Good idea, I think relying solely on javadoc tags for reference docs would >> require including >> too much docs in the code. > > We could use the "package.html", which sits beside each > component, to add this supplemental description. In that way, > the info gets automatically included into Javadocs as well. > Some components are already doing this. So a side-benefit is > that Javadocs are more useful too. See > http://xml.apache.org/cocoon/apidocs/ > and choose a component that has something in the right-hand > column. Note that these include the "Description" at the > bottom of their page. > > --David
I think that would dilute both documentaiton conepts actually. That is great and useful for the javadocs - but that is for developer docs, not user docs. And users shouldn't need to delve into the javadocs... -- "The heights of genius are only measurable by the depths of stupidity."
