From 0634a2201232ad0ec4240238eab5e96da3a81df4 Mon Sep 17 00:00:00 2001 From: Robert burner Schadek Date: Thu, 19 Mar 2015 13:28:27 +0100 Subject: [PATCH] std.algo.cmp.max docu * Params * Returns quickfur review fixes comma quickfur klickverbot --- std/algorithm/comparison.d | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/std/algorithm/comparison.d b/std/algorithm/comparison.d index 2f7fc2415b6..ef9343a3723 100644 --- 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)