From 8195bfd0a49fbeef2576a520cd4d7d1aaa74a417 Mon Sep 17 00:00:00 2001 From: Ashar Fuadi Date: Sun, 15 Dec 2024 14:14:57 +0700 Subject: [PATCH] Docs: add parameters to validator doc --- web/docs/api/04-validators/01-core.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/web/docs/api/04-validators/01-core.md b/web/docs/api/04-validators/01-core.md index 580f23f..801bdd0 100644 --- a/web/docs/api/04-validators/01-core.md +++ b/web/docs/api/04-validators/01-core.md @@ -26,7 +26,7 @@ ScalarValidator valueOf(T val); This validator contains the following function: -#### `.isBetween()` +#### `.isBetween(minVal, maxVal)` ```cpp bool ScalarValidator::isBetween(T minVal, T maxVal); @@ -49,7 +49,7 @@ VectorElementValidator eachElementOf(const std::vector& vec); This validator contains the following functions: -#### `.isBetween()` +#### `.isBetween(minVal, maxVal)` ```cpp bool VectorElementValidator::isBetween(T minVal, T maxVal); @@ -57,13 +57,13 @@ bool VectorElementValidator::isBetween(T minVal, T maxVal); Returns whether each element of `vec` is between `minVal` and `maxVal`, inclusive. -#### `.satisfies()` +#### `.satisfies(pred)` ```cpp -bool VectorElementValidator::satisfies(std::function predicate); +bool VectorElementValidator::satisfies(std::function pred); ``` -Returns whether `predicate(e)` returns true for each `e` element of `vec`. +Returns whether `pred(e)` returns true for each `e` element of `vec`. --- @@ -80,7 +80,7 @@ MatrixElementValidator eachElementOf(const std::vector>& mat); This validator contains the following functions: -#### `.isBetween()` +#### `.isBetween(minVal, maxVal)` ```cpp bool MatrixElementValidator::isBetween(T minVal, T maxVal); @@ -88,13 +88,13 @@ bool MatrixElementValidator::isBetween(T minVal, T maxVal); Returns whether each element of `mat` is between `minVal` and `maxVal`, inclusive. -#### `.satisfies()` +#### `.satisfies(pred)` ```cpp -bool MatrixElementValidator::satisfies(std::function predicate); +bool MatrixElementValidator::satisfies(std::function pred); ``` -Returns whether `predicate(e)` returns true for each `e` element of `mat`. +Returns whether `pred(e)` returns true for each `e` element of `mat`. --- @@ -110,7 +110,7 @@ StringElementValidator eachCharacterOf(const std::string& str); This validator contains the following functions: -#### `.isBetween()` +#### `.isBetween(minVal, maxVal)` ```cpp bool StringElementValidator::isBetween(char minVal, char maxVal);