commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Apache Wiki <wikidi...@apache.org>
Subject [Jakarta-commons Wiki] Update of "id/1.0ReleasePlan" by JörgSchaible
Date Mon, 16 Jan 2006 21:37:43 GMT
Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Jakarta-commons Wiki" for change notification.

The following page has been changed by JörgSchaible:
http://wiki.apache.org/jakarta-commons/id/1%2e0ReleasePlan

The comment on the change is:
Propose @since in javadoc

------------------------------------------------------------------------------
  
   * Drop duplicated javadoc
    If a method is overwritten in a derived class, it should either describe, what it does
different or don't add any javadoc, so that the documentation is automatically copied by the
javadoc tool. In case of repeated description for a single parameter, return value or thrown
exception an {@inherit} element should be used.
+  * Add @since
+   It is much more helpful for a developer if the documentation clearly states which method
was available in which version. The usual @version is more useful for internal usage.
    
  === Quality ===
    

---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org


Mime
View raw message