Name: rmT116609 Date: 03/20/2003


A DESCRIPTION OF THE PROBLEM :
Logger.log methods which accept an Object or array of Objects as arguments/parameters have extremely poor documentation. The description of these parameters is "parameter to the message" or " parameters to the message." There is no explanation of what this means nor any mention of the fact that internally java.text.MessageFormat is being used, and that the String message passed in must use the arguments in a specified format. Users must view the source of Logger to determine the correct usage of these methods.

EXPECTED VERSUS ACTUAL BEHAVIOR :
At a bare minimum, a "@see" reference to MessageFormat. Ideally, a full explanation of how to use the arguments to these log methods.
parameter to the message

http://java.sun.com/j2se/1.4.1/docs/api/java/util/logging/Logger.html#log(java.util.logging.Level,%20java.lang.String,%20java.lang.Object)

http://java.sun.com/j2se/1.4.1/docs/api/java/util/logging/Logger.html#log(java.util.logging.Level,%20java.lang.String,%20java.lang.Object[])
(Review ID: 182887)
======================================================================