Summary

In the specification for com.sun.net.httpserver.HttpPrincipal the @param tag is missing for the equals method's sole parameter, i.e. Object another.

Problem

Currently, the equals method for HttpPrincipal does not not specify that it takes a parameter.

Solution

Add in an @param tag along with the parameter name and description to inform the user of its use.

Specification

  /**
   * Compare two instances of {@code HttpPrincipal}. Returns {@code true} if
   * <i>another</i> is an instance of {@code HttpPrincipal}, and its username
   * and realm are equal to this object's username and realm. Returns {@code false}
   * otherwise.
   *
+  * @param another the object to compare this instance of {@code HttpPrincipal} against
   * @return {@code true} or {@code false} depending on whether objects are
   * equal or not
   */
  public boolean equals(Object another) {