DO NOT REPLY [Bug 16669] New: - JavaDoc Errata

[bu...@apache.org]

DO NOT REPLY TO THIS EMAIL, BUT PLEASE POST YOUR BUG 
RELATED COMMENTS THROUGH THE WEB INTERFACE AVAILABLE AT
<http://nagoya.apache.org/bugzilla/show_bug.cgi?id=16669>.
ANY REPLY MADE TO THIS MESSAGE WILL NOT BE COLLECTED AND 
INSERTED IN THE BUG DATABASE.

http://nagoya.apache.org/bugzilla/show_bug.cgi?id=16669

JavaDoc Errata

           Summary: JavaDoc Errata
           Product: Commons
           Version: 1.0.1 Final
          Platform: All
               URL: http://jakarta.apache.org/commons/lang/api/index.html
        OS/Version: All
            Status: NEW
          Severity: Minor
          Priority: Other
         Component: Lang
        AssignedTo: commons-dev@jakarta.apache.org
        ReportedBy: kenfitzpatrick@yahoo.com


Please note these (perhaps trivial) JavaDoc errors:

1 - org.apache.commons.lang.builder.ToStringBuilder:
"To use this class write code as follows:
 public class Person {
   ...
   public String toString() {
     return new ToStringBuilder(this).
       append(name, "name").     <--- wrong order of parameters ***
       append(age, "age").       <--- wrong order of parameters ***
       append(smoker, "smoker"). <--- wrong order of parameters ***
       toString();
 
2 - org.apache.commons.lang.builder.CompareToBuilder 
"Typical use for the code is as follows:
  public int ***comapareTo***(Object o) { <--- spelling of "compareTo"

3 - org.apache.commons.lang.ObjectUtils
"public static final ObjectUtils.Null NULL
    Singleton ...
    Another example is ***HashTable*** <--- spelling of "Hashtable"

(same thing in org.apache.commons.lang.ObjectUtils.Null)

Thanks for the great work!

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