Usage

At the minimum, Javadoc is present for every public class, and every public or protected member of such a class, with a few exceptions:

  • is optional for "simple, obvious" methods like getFoo, in cases where there really and truly is nothing else worthwhile to say but "Returns the foo".
  • in methods that overrides a supertype method.