Originally posted by David Abramowicz:
Hi all.
Do you think it is necessary to document with JavaDoc methods that are from interfaces, other than with the @see tag? For instance, in one of my controllers, I have an actionPerformed method, and the JavaDoc generated for it is:
actionPerformed
public void actionPerformed(java.awt.event.ActionEvent event)Specified by:
actionPerformed in interface java.awt.event.ActionListener
See Also:
ActionListener.actionPerformed(java.awt.event.ActionEvent)
So do you reckon that's sufficient?
Cheers /Dave
If your method implements a method described in the
Java API, you might want to say what it does, or use an anonymous inner class, in which case you probably don't need the javadoc.
If it implements a method described in one of your interfaces you can use
to have javadoc include the documentation from the parent interface.