My first answer was "no!", but I think I don't know what you mean by "match exactly".

We want any javadoc for javax.* classes to have a pointer to the sun javadoc (so it's clear we aren't trying to reproduce the spec) and have information about *our* implementation, clarifications, how we interpreted the spec, etc.

Repeating the sun javadoc makes no sense.

As for org.apache.*, that will probably be richer and more basically descriptive...

geir

karan malhi wrote:
Will the javadoc have to match exactly with the RI api docs?

Geir Magnusson Jr wrote:



karan malhi wrote:

Do we need to add javadoc comments in classes?


Sure.  Javadoc is good.

How to deal with deprecated classes,methods and constructors?


Mark them deprecated?

My guess is that we should not care whether something is deprecated or not. We would still need that stuff for backward compatibility. However, I still would like to know if we need to keep certain rules/guidelines in mind when implementing deprecated stuff.


People use deprecated stuff. I think that there is no difference in "rules", but probably in how much effort....

geir



Reply via email to