diff options
| author | Kaarle Ritvanen <kaarle.ritvanen@datakunkku.fi> | 2015-04-03 10:40:28 +0300 |
|---|---|---|
| committer | Kaarle Ritvanen <kaarle.ritvanen@datakunkku.fi> | 2015-04-10 18:17:00 +0300 |
| commit | a92dc45aee3f599926c77294328db38c5b2544eb (patch) | |
| tree | 0f31580b868245cabe733864f9d99901730c3279 /aconf/model/root.lua | |
| parent | 3baaf91de453d35b095881478be8d88b3fc2b97a (diff) | |
| download | aconf-a92dc45aee3f599926c77294328db38c5b2544eb.tar.bz2 aconf-a92dc45aee3f599926c77294328db38c5b2544eb.tar.xz | |
docs: describe functionality used in the dnsmasq modulev0.5.0
Diffstat (limited to 'aconf/model/root.lua')
| -rw-r--r-- | aconf/model/root.lua | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/aconf/model/root.lua b/aconf/model/root.lua index eef48ec..b60ce59 100644 --- a/aconf/model/root.lua +++ b/aconf/model/root.lua @@ -63,11 +63,12 @@ M.topology = setmetatable( --- inject a new field to the root model. -- @tparam string name name of the field --- @tparam Field|Model field type of the field, specified by a --- subclass of @{Field} or an instance of such. Can also be specified --- by a subclass of Model. +-- @param field (<i>@{Field}</i> or <i>[<Model>](#new)</i>) type +-- of the field, specified by a subclass of @{Field} or an instance of +-- such. Can also be specified by a [<Model>](#new). -- @tparam ?{[string]=any,...} params field parameters. Applicable --- when field type is specified by a class (not an instance). +-- when field type is specified by a @{Field} subclass or +-- [<Model>](#new). function M.register(name, field, params) if not params then params = {} end params.create = true |