Update documentation for num.clamp.

(partially) fixes #27923
BUG= http://dartbug.com/27923
R=lrn@google.com

Review URL: https://codereview.chromium.org/2541513002 .
This commit is contained in:
Florian Loitsch 2016-12-01 11:01:44 -08:00
parent 0c31815f1c
commit 222d80ad9d

View file

@ -296,6 +296,9 @@ abstract class num implements Comparable<num> {
* The comparison is done using [compareTo] and therefore takes `-0.0` into
* account. This also implies that [double.NAN] is treated as the maximal
* double value.
*
* The arguments [lowerLimit] and [upperLimit] must form a valid range where
* `lowerLimit.compareTo(upperLimit) <= 0`.
*/
num clamp(num lowerLimit, num upperLimit);