Le Sun, 21 Jun 2009 11:22:34 +0200, Bernd Fondermann <[email protected]> a écrit :
> Emmanuel Lecharny wrote: > > Niklas Gustavsson wrote: > >> Hi > >> > >> For Vysper, the export page has been updated > >> (https://issues.apache.org/jira/browse/VYSPER-47), Bernd has > >> assembled a list of all contributors > >> (https://issues.apache.org/jira/browse/VYSPER-45) and I think we've > >> done the due diligence even though the issue is not closed > >> (https://issues.apache.org/jira/browse/VYSPER-44). Therefore, I > >> think it's time to move Vysper out of the sandbox. If no one > >> objects, I'll start a vote in a few days. > >> > > > > Well, sorry for being a bit a PITA, but I would like to see more > > javadoc in the project. We already have been burnt (and still > > are !!!) with MINA suffering from such a problem that I would like > > to avoid it again. > > > > I don't mean it should be perfect, but at least, a first pass is > > necessary. > > Of course we need more javadoc, just as we need more code comments, > unit tests, user doc etc. All of that gets my +1. > > To turn this into an actually task, could you point out areas/classes > that especially lack javadoc? > > > I know this sounds painful, but this is also the price to pay to be > > able to jump into the code, to get more committers involved, and to > > receive less basic questions on the mailing list. > > At this point, I'd be happy to actually receive *more* questions ;-) > > For me, writing javadoc isn't painful at all, when I see something > under-documented. I generally consider documentation a quality issue, > not a quantity issue. > > Bernd Hi, The followed rule for MINA Javadoc is : - a comment in each class header - doco on each public/protected method (or on the parent class public method with inherited tags) The main point is to help user to understand the public API, for the internal doco it's more flexible and it's good to hear great feedback from Michael :) Anyway the javadoc issue could be blocking for a 1.0 release, but looks like we aren't there :) On the sandbox moving I think it's a great idea, since the community around Vysper is growing. Julien
signature.asc
Description: PGP signature
