I thought I remembered dan doing something like this, but could not remember the name. That is why I sent the preliminary out before checking it in.
I just looked at the one dan referred to and I think my approach is wrong, at least if using javadoc to provide this information. What is appropriate in the package.html is an overview of what the package does - but I think the per file information should just be what javadoc provides and I should just make sure the javadoc in the individual files works. Let me see if I can get current javadoc to give what I think it should and you let me know if it looks right. Likely to check in very limited html package.html with just overview of package - you can format as you see fit. I thought that the apache site was going to have a built set of the source code javadoc, at least from releases if not from nightly builds but I could not find it. Does it exist? Dibyendu Majumdar wrote: > From: "Mike Matrigali" <[EMAIL PROTECTED]> > >>First here is a start at info about files in the index directory. >>Is this a good start. I would actually like to check this information >>into the source code, and am looking for some opinions about how best >>to do it. Currently it is just text, but ideally I would like to hook >>it up to html and the javadoc system some how. > > > Hi Mike. I guess the correct way would be create a package.html file and > check this in. I can do the conversion from your text. > > >>Below is a quick description of what the files do, see javadoc in the >>individual files for more explanation of each. > > > I would suggest that we update the documentation in each of Java files so > that all this becomes part of the Javadoc. I'd like to correct the existing > Javadoc comments and also add new new comments. Alternatively, if you add > the comments yourself, I can fix the html tags so that the comments come out > properly in Javadoc. > > Regards > > Dibyendu > > >
