From 84e6bbb86d176b71bf52832e1bf233478e61045e Mon Sep 17 00:00:00 2001 From: Emmanuel Lepage Vallee Date: Sun, 18 Aug 2019 19:27:50 -0400 Subject: [PATCH] doc: Improve the common documentation between all rules modules. It was missing lesser/greater and the `id` type wasn't rendered properly. --- docs/common/rule.ldoc | 20 +++++++++++++++++++- docs/config.ld | 1 + 2 files changed, 20 insertions(+), 1 deletion(-) diff --git a/docs/common/rule.ldoc b/docs/common/rule.ldoc index ec0fa7a54..ebab28c41 100644 --- a/docs/common/rule.ldoc +++ b/docs/common/rule.ldoc @@ -50,6 +50,24 @@ -- @see rule -- @see except +--- A table which content will be compared to the target object current properties. +-- +-- The comparison will be made using the lesser (`<`) operator. +-- +-- @rulecomponent rule_lesser +-- @param table +-- @see rule +-- @see except + +--- A table which content will be compared to the target object current properties. +-- +-- The comparison will be made using the lesser (`>`) operator. +-- +-- @rulecomponent rule_greater +-- @param table +-- @see rule +-- @see except + --- An identifier for this rule. -- -- It can be anything. It will be compared with the `==` operator. Strings are @@ -60,4 +78,4 @@ -- modify or disable a rule. -- -- @rulecomponent id --- @param table|string|number|function +-- @tparam table|string|number|function id diff --git a/docs/config.ld b/docs/config.ld index 37fa7a8ac..afceff201 100644 --- a/docs/config.ld +++ b/docs/config.ld @@ -756,6 +756,7 @@ local display_type = { deprecatedproperty = true, clientruleproperty = true, matchingproperty = true, + rulecomponent = true, } -- Show return values.