From a92dc45aee3f599926c77294328db38c5b2544eb Mon Sep 17 00:00:00 2001 From: Kaarle Ritvanen Date: Fri, 3 Apr 2015 10:40:28 +0300 Subject: docs: describe functionality used in the dnsmasq module --- aconf/model/root.lua | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) (limited to 'aconf/model/root.lua') 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 (@{Field} or [<Model>](#new)) 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 -- cgit v1.2.3