Bernd Fondermann wrote:
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 quickly checked the code, so I don't have a list right now. However,
the process to follow is :
- check all the classes with no header
- Javadoc is absolutely mandatory for Interfaces. Using an @inherited
annotation for implementing classes is always a good way to know that
the javadoc is written in the interface.
- Javadoc for private fields is also needed.
I will try to get a list this afternoon, as I will take a train and
won't have a network connection.
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 ;-)
yeah, don't worry, it will happen :)
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.
Totally +1.
Bernd
--
--
cordialement, regards,
Emmanuel Lécharny
www.iktek.com
directory.apache.org
