path: root/aconf/model/root.lua
diff options
authorKaarle Ritvanen <>2016-12-16 14:51:28 +0200
committerKaarle Ritvanen <>2016-12-18 23:02:07 +0200
commitc248dca6eeaa6994fc3ab663f431238266417241 (patch)
tree60fc868dcf8f3bcfc21a8d82265bc45420b2adaf /aconf/model/root.lua
parent2cc92ad225ef0fd2756b44c9dc81c59fedbf2f20 (diff)
doc: section for field constructor parameters
Diffstat (limited to 'aconf/model/root.lua')
1 files changed, 6 insertions, 6 deletions
diff --git a/aconf/model/root.lua b/aconf/model/root.lua
index b60ce59..32b013d 100644
--- a/aconf/model/root.lua
+++ b/aconf/model/root.lua
@@ -1,5 +1,5 @@
-Copyright (c) 2012-2015 Kaarle Ritvanen
+Copyright (c) 2012-2016 Kaarle Ritvanen
See LICENSE file for license details
@@ -63,12 +63,12 @@ M.topology = setmetatable(
--- inject a new field to the root model.
-- @tparam string name name of the field
--- @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).
+-- @param field (<i>[&lt;Field&gt;](#Field_constructors)</i> or
+-- <i>[&lt;Model&gt;](#new)</i>) type of the field, specified by a
+-- field constructor or instance. Can also be specified by a model.
-- @tparam ?{[string]=any,...} params field parameters. Applicable
--- when field type is specified by a @{Field} subclass or
--- [&lt;Model&gt;](#new).
+-- when the type of the field is specified by a model or a field
+-- constructor.
function M.register(name, field, params)
if not params then params = {} end
params.create = true