Uploaded image for project: 'Commons Lang'
  1. Commons Lang
  2. LANG-91

JavaDoc Errata

    XMLWordPrintableJSON

Details

    • Bug
    • Status: Closed
    • Minor
    • Resolution: Fixed
    • 2.0
    • 2.0
    • None
    • None
    • Operating System: All
      Platform: All

    • 16669

    Description

      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!

      Attachments

        Activity

          People

            Unassigned Unassigned
            kenfitzpatrick@yahoo.com Ken Fitzpatrick
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: