doc: Improve the common documentation between all rules modules.
It was missing lesser/greater and the `id` type wasn't rendered properly.
This commit is contained in:
parent
fc526d2aef
commit
84e6bbb86d
|
@ -50,6 +50,24 @@
|
||||||
-- @see rule
|
-- @see rule
|
||||||
-- @see except
|
-- @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.
|
--- An identifier for this rule.
|
||||||
--
|
--
|
||||||
-- It can be anything. It will be compared with the `==` operator. Strings are
|
-- It can be anything. It will be compared with the `==` operator. Strings are
|
||||||
|
@ -60,4 +78,4 @@
|
||||||
-- modify or disable a rule.
|
-- modify or disable a rule.
|
||||||
--
|
--
|
||||||
-- @rulecomponent id
|
-- @rulecomponent id
|
||||||
-- @param table|string|number|function
|
-- @tparam table|string|number|function id
|
||||||
|
|
|
@ -756,6 +756,7 @@ local display_type = {
|
||||||
deprecatedproperty = true,
|
deprecatedproperty = true,
|
||||||
clientruleproperty = true,
|
clientruleproperty = true,
|
||||||
matchingproperty = true,
|
matchingproperty = true,
|
||||||
|
rulecomponent = true,
|
||||||
}
|
}
|
||||||
|
|
||||||
-- Show return values.
|
-- Show return values.
|
||||||
|
|
Loading…
Reference in New Issue