What you could do is create a patch (Unified Diff) and send it as an
attachement with your email. That's the best/ fastest way to have such
stuff applied. And we don't need to have lengthy discussions on javadocs
either.
I'm not a saint, but I am usually committed to writing good javadocs.
Not everyone is so comitted (sometimes just due to lack of time). So,
please provide us with improvements. That said, how much actual code of
other open source products (or closed source when you had the chance to
get them) did you look at? I think Wicket does a decent job overall.
Eelco
Gili wrote:
Can someone please explain to me the the point the Javadoc for
Component.isVersioned()? I'm picking on this one as an example of a
bigger problem in some of the Wicket documentation. Some are very well
documented while others are really *really* poor.
There is absolutely no value added when isVersioned is documented
as "Returns the isVersioned". As an end-user, the first thing going
through my mind when I read this would be: What is "isVersioned"?!
What is versioning?! I'm expecting to see a short explanation of what
versioning is and what it means for a component to return true or
false? How does this affect the component's behavior?
I'm just pointing this out here for future reference because I
can't open new bug reports for each and every one of these things (I
tried doing so in the past) especially seeing as new ones are being
added every day. Can the team please try to provide verbose
documentation or none at all? At least when you provide none at all
your IDE will warn you about the missing documentation; it'll never
warn you about bad documentation :)
Thanks,
Gili
-------------------------------------------------------
SF.Net email is Sponsored by the Better Software Conference & EXPO
September 19-22, 2005 * San Francisco, CA * Development Lifecycle Practices
Agile & Plan-Driven Development * Managing Projects & Teams * Testing & QA
Security * Process Improvement & Measurement * http://www.sqe.com/bsce5sf
_______________________________________________
Wicket-develop mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/wicket-develop
