From c248dca6eeaa6994fc3ab663f431238266417241 Mon Sep 17 00:00:00 2001 From: Kaarle Ritvanen Date: Fri, 16 Dec 2016 14:51:28 +0200 Subject: doc: section for field constructor parameters --- aconf/model/root.lua | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'aconf/model/root.lua') diff --git a/aconf/model/root.lua b/aconf/model/root.lua index b60ce59..32b013d 100644 --- a/aconf/model/root.lua +++ b/aconf/model/root.lua @@ -1,5 +1,5 @@ --[[ -Copyright (c) 2012-2015 Kaarle Ritvanen +Copyright (c) 2012-2016 Kaarle Ritvanen See LICENSE file for license details --]] @@ -63,12 +63,12 @@ M.topology = setmetatable( --- inject a new field to the root model. -- @tparam string name name of the field --- @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). +-- @param field ([<Field>](#Field_constructors) or +-- [<Model>](#new)) type of the field, specified by a +-- field constructor or instance. Can also be specified by a model. -- @tparam ?{[string]=any,...} params field parameters. Applicable --- when field type is specified by a @{Field} subclass or --- [<Model>](#new). +-- when the type of the field is specified by a model or a field +-- constructor. function M.register(name, field, params) if not params then params = {} end params.create = true -- cgit v1.2.3