there are
1) Java Docs
2) wiki pages
3) maven XML documents which generate web site of myfaces
these should be updated and synchronized together, I have started to work on wiki, I hope when I finish we can start synchronizing javadocs and web pages.
if you are interested to help you are very welcome we can divide the work between our selves.
also soon there will be a book about MyFaces
http://www.apress.com/book/bookDisplay.html?bID=10179
On 10/30/06, Sebastian Menge <[EMAIL PROTECTED]> wrote:
Hi
I've subscribed to this list to post just one remark/question.
Myfaces is a great implementation. Another example of an opensource
effort that will soon be better than the RI.
But! ;-)
Please take more care on documentation. The javadoc is really really a
joke.
Please dont mind. I want to use myfaces in my setting and if I could I
also would contribute something.
But good documentation is for me about 50% of a good project.
I was looking for _anything_ useful regarding the navigationPanels. No
way. There are some tags, there are some classes, no explanations, no
cross references between tags and classes etc.
There are a few postings on [EMAIL PROTECTED] or some forums, there are some
wikipages. But such things should really be documented at some central
place like javadoc ...
Sorry, after nearly a week of wasting time with undocumented things, i
got a little bit angry.
Please take this as a suggestion to make myfaces a high quality project.
Thanks alot for all the good work,
Sebastian.
PS I know, writing docs is not so exciting as implementing features or
new components. And if you want to do it good, its really difficult. (I
think even more difficult than programming, because you have to think
like your potential reader(s) and not only like the machine ...). At
last a good documented API can give you a good feeling to... Really :-)
To be a little bit constructive: There is a good text on this topic from
Sun. Please read it and give it a try.
http://java.sun.com/j2se/javadoc/writingdoccomments/
--
Arash Rajaeeyan
