diff options
| author | Kaarle Ritvanen <kaarle.ritvanen@datakunkku.fi> | 2015-04-02 16:34:13 +0300 |
|---|---|---|
| committer | Kaarle Ritvanen <kaarle.ritvanen@datakunkku.fi> | 2015-04-03 00:45:53 +0300 |
| commit | 3baaf91de453d35b095881478be8d88b3fc2b97a (patch) | |
| tree | dbeeedc851f0d8130907574ef8506904c5c44570 /aconf/model/init.lua | |
| parent | c7bce46f22ff9c41e3598d42400368d3c733316c (diff) | |
| download | aconf-3baaf91de453d35b095881478be8d88b3fc2b97a.tar.bz2 aconf-3baaf91de453d35b095881478be8d88b3fc2b97a.tar.xz | |
initial developer documentation
descriptions for all functions and classes used by the openssh module
Diffstat (limited to 'aconf/model/init.lua')
| -rw-r--r-- | aconf/model/init.lua | 8 |
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) end +--- 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 |