Name: rm29839 Date: 07/16/98


In the Javadoc API documentation, in the method
description for java.awt.datatransfer.DataFlavor.
getParameter, the paramName parameter is undocumented,
and the return value description is quite unclear
and possibly in error.

http://java.sun.com:80/products/jdk/1.2/docs/api/java.awt.datatransfer.DataFlavor.html#getParameter(java.lang.String)

The getParameter method description says only:

  getParameter

  public String getParameter(String paramName)

      Returns:
            the value of the name parameter


First of all, the paramName parameter is not
documented. In fact, there's no method-descrip-
tion sentence either.

Second, the return-value description is ambiguous:

Does "the name parameter" refer to paramName? If
so, does getParameter just simply return its value?
(I assume not.)

Does "the name parameter" refer to some parameter
of DataFlavor? of the MIME type? of something
else? (If it does, it should say what it's
referring to.)

Is the wording "the name parameter" supposed to
be "the named parameter"? That is, does getParameter
get the value of some parameter (again, of what?)
named by the paramName parameter?
(Review ID: 35229)
======================================================================