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:
Emmanuel Lepage Vallee 2019-08-18 19:27:50 -04:00
parent fc526d2aef
commit 84e6bbb86d
2 changed files with 20 additions and 1 deletions

View File

@ -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

View File

@ -756,6 +756,7 @@ local display_type = {
deprecatedproperty = true,
clientruleproperty = true,
matchingproperty = true,
rulecomponent = true,
}
-- Show return values.