summaryrefslogtreecommitdiffstats
path: root/aconf/model/root.lua
diff options
context:
space:
mode:
Diffstat (limited to 'aconf/model/root.lua')
-rw-r--r--aconf/model/root.lua9
1 files changed, 5 insertions, 4 deletions
diff --git a/aconf/model/root.lua b/aconf/model/root.lua
index eef48ec..b60ce59 100644
--- a/aconf/model/root.lua
+++ b/aconf/model/root.lua
@@ -63,11 +63,12 @@ M.topology = setmetatable(
--- inject a new field to the root model.
-- @tparam string name name of the field
--- @tparam Field|Model field type of the field, specified by a
--- subclass of @{Field} or an instance of such. Can also be specified
--- by a subclass of Model.
+-- @param field (<i>@{Field}</i> or <i>[&lt;Model&gt;](#new)</i>) type
+-- of the field, specified by a subclass of @{Field} or an instance of
+-- such. Can also be specified by a [&lt;Model&gt;](#new).
-- @tparam ?{[string]=any,...} params field parameters. Applicable
--- when field type is specified by a class (not an instance).
+-- when field type is specified by a @{Field} subclass or
+-- [&lt;Model&gt;](#new).
function M.register(name, field, params)
if not params then params = {} end
params.create = true