path: root/aconf/model/init.lua
diff options
Diffstat (limited to 'aconf/model/init.lua')
1 files changed, 8 insertions, 0 deletions
diff --git a/aconf/model/init.lua b/aconf/model/init.lua
index 437cb93..667da2f 100644
--- a/aconf/model/init.lua
+++ b/aconf/model/init.lua
@@ -3,6 +3,7 @@ Copyright (c) 2012-2015 Kaarle Ritvanen
See LICENSE file for license details
+--- @module aconf.model
local M = {}
M.error = require('aconf.error')
@@ -241,6 +242,13 @@ function M.Collection:load(context, options)
+--- list field, inherits @{Field}. A list is an ordered collection of
+--- members. The path of a list member is that of the list augmented
+--- by the index of the member.
+-- @klass List
+-- @tparam Field|Model type subclass of @{Field}, instance of such, or
+-- subclass of Model specifying the type of the members.
+-- @tparam ?string ui_member user-friendly noun for a list member.
M.List = class(M.Collection)
function M.List:init(params) super(self, M.List):init(params, node.List) end