std.algo.cmp.max docu

* Params * Returns quickfur review fixes comma quickfur klickverbot
dlang · Mar 21, 2015 · 0634a22 · 0634a22
1 parent e1d2c9e
commit 0634a22
Showing 1 changed file with 9 additions and 1 deletion.
diff --git a/std/algorithm/comparison.d b/std/algorithm/comparison.d
@@ -1194,7 +1194,15 @@ levenshteinDistanceAndPath(alias equals = "a == b", Range1, Range2)
 
 // max
 /**
-Returns the maximum of the passed-in values.
+Iterates the passed arguments and return the maximum value.
+
+Params:
+    args = The values to select the maximum from. At least two arguments must
+    be passed.
+
+Returns:
+    The maximum of the passed-in args. The type of the returned value is
+    the type among the passed arguments that is able to store the largest value.
 */
 MaxType!T max(T...)(T args)
     if (T.length >= 2)