On Tue, 2002-02-19 at 03:18, Rainer Klute wrote: > "Andrew C. Oliver" <[EMAIL PROTECTED]> wrote: > >On Mon, 2002-02-18 at 02:48, Rainer Klute wrote: > >> "Andrew C. Oliver" <[EMAIL PROTECTED]> wrote: > >> >So far all of the POI subprojects have a helpful "How-TO" and code > >> >samples demonstrating their use. The POI user community seems to > >> >greatly appreciate this. > >> > >> I'll look at it as time permits. > >> > > > >I'm not just bitchy, I'm the one who gets all the emails if it isn't > >there. If you aren't capable then I'll do it. Just, If I have to > >figure it out and do it then it won't necessarily be accurate. > > Calm down, I'll do it. It's just a matter of time. And I am not talking about months >or years. > > > >Furthermore if you look at the new web page, you'll notice all the other > >APIs have it. If this one is the only one that doesn't it: > > > >1. Makes the web page look stupid. > >2. Speaks volumes about quality. > > > >If you feel you've adequately described all aspects in the javadoc, > >simply copying those passages and formatting them into a conceptual > >overview should take all of 5 minutes right? > > Yeah, and if you change something in the javadocs you have to do the same in the >other documentation. Redundancy is the root of all evil (well, in this context). I >prefer to keep one sets of documents here and the other sets of documents there. I >have no problem with moving over the stuff from the HPSF package description to the >HOW-TO/Use Case area. But I don't want to maintain the same information at two >different places. >
You're right! Submit a RFE to sun that Javadoc should be able to xinclude sections of documentation. Kind of the coding standard we agreed upon (off the top of my head) as a group was: 1. all public and protected functions must have javadoc 2. all subprojects must have at least a how-to and some sample code explaining their basic use. 3. stuff must compile 4. the build must work I think that was about the extent of our coding standards. > Best regards > Rainer Klute > > RAINER KLUTE IT-CONSULTING > Dipl.-Inform. > Rainer Klute E-Mail: [EMAIL PROTECTED] > K�rner Grund 24 Telefon: +49 172 2324824 > D-44143 Dortmund Telefax: +49 231 5349423 > -- www.superlinksoftware.com www.sourceforge.net/projects/poi - port of Excel format to java http://developer.java.sun.com/developer/bugParade/bugs/4487555.html - fix java generics! The avalanche has already started. It is too late for the pebbles to vote. -Ambassador Kosh
