diff options
author | Kaarle Ritvanen <kaarle.ritvanen@datakunkku.fi> | 2016-12-16 13:11:53 +0200 |
---|---|---|
committer | Kaarle Ritvanen <kaarle.ritvanen@datakunkku.fi> | 2016-12-16 16:09:55 +0200 |
commit | 2cc92ad225ef0fd2756b44c9dc81c59fedbf2f20 (patch) | |
tree | aa57385b8cb98d412169c0eacffc23f6f38f4e45 /aconf/model/init.lua | |
parent | 589156c6b29825e79642cf0d78bd9f6a46b47f96 (diff) | |
download | aconf-2cc92ad225ef0fd2756b44c9dc81c59fedbf2f20.tar.bz2 aconf-2cc92ad225ef0fd2756b44c9dc81c59fedbf2f20.tar.xz |
doc: add clarifications and clean up
Diffstat (limited to 'aconf/model/init.lua')
-rw-r--r-- | aconf/model/init.lua | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/aconf/model/init.lua b/aconf/model/init.lua index 6c78b8f..35dfc7b 100644 --- a/aconf/model/init.lua +++ b/aconf/model/init.lua @@ -1,5 +1,5 @@ --[[ -Copyright (c) 2012-2015 Kaarle Ritvanen +Copyright (c) 2012-2016 Kaarle Ritvanen See LICENSE file for license details --]] @@ -206,6 +206,13 @@ end M.Model = fld.Model +--- collection field, inherits @{Field}. +-- @klass Collection +-- @param type (<i>@{Field}</i> or <i>[<Model>](#new)</i>) +-- subclass of @{Field}, instance of such, or +-- [**<Model>**](#new) specifying the type of the members. +-- @tparam ?string ui_member user-friendly noun for a member of this +-- collection M.Collection = class(fld.TreeNode) function M.Collection:init(params, itype) @@ -231,13 +238,6 @@ function M.Collection:auto_ui_name(name) return super(self, M.Collection):auto_ui_name(name) end ---- collection field, inherits @{Field}. --- @klass Collection --- @param type (<i>@{Field}</i> or <i>[<Model>](#new)</i>) --- subclass of @{Field}, instance of such, or --- [**<Model>**](#new) specifying the type of the members. --- @tparam ?string ui_member user-friendly noun for a member of this --- collection function M.Collection:load(context, options) if not self.iparams.field then self.iparams.field = to_field(self.type) |