From f8fd5410ccdf13a2bfb8cbbf48ada18495411c01 Mon Sep 17 00:00:00 2001 From: Robert burner Schadek Date: Wed, 18 Mar 2015 22:06:55 +0100 Subject: [PATCH] doc comments for algo.cmp.among lowercase to search for --- std/algorithm/comparison.d | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/std/algorithm/comparison.d b/std/algorithm/comparison.d index f7778136a..2f7fc2415 100644 --- a/std/algorithm/comparison.d +++ b/std/algorithm/comparison.d @@ -63,6 +63,15 @@ of the first matching value in $(D values), or $(D 0) if $(D value) is not _among $(D values). The predicate $(D pred) is used to compare values, and uses equality by default. +Params: + pred = The predicate used to compare the values. + value = The value to search for. + values = The values to compare the value to. + +Returns: + 0 if value was not found among the values, otherwise the index of the + found value plus one is returned. + See_Also: $(LREF find) and $(LREF canFind) for finding a value in a range.