path: root/aconf/model/model.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/model.lua
parent2cc92ad225ef0fd2756b44c9dc81c59fedbf2f20 (diff)
doc: section for field constructor parameters
Diffstat (limited to 'aconf/model/model.lua')
1 files changed, 3 insertions, 2 deletions
diff --git a/aconf/model/model.lua b/aconf/model/model.lua
index 7417115..3a28d90 100644
--- a/aconf/model/model.lua
+++ b/aconf/model/model.lua
@@ -70,8 +70,9 @@ end
--- create a new model, representing a data model with a pre-defined
-- structure. The model's fields can be defined by assigning it
-- key&ndash;value pairs. The key will be the name of the field and
--- the value will determine its type. The value shall be a subclass of
--- @{Field}, an instance of such, or another **&lt;Model&gt;**.
+-- the value will determine its type. The value shall be a [field
+-- constructor](#Field_constructors), an instance of field, or another
+-- **&lt;Model&gt;**.
-- @param base (optional <i>**&lt;Model&gt;**</i>) base model
-- inherited by the new model.
-- @return <i>**&lt;Model&gt;**</i> new model