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/field.lua | 70 +++++++-------------------------------------------- 1 file changed, 9 insertions(+), 61 deletions(-) (limited to 'aconf/model/field.lua') diff --git a/aconf/model/field.lua b/aconf/model/field.lua index 70930d7..f1236aa 100644 --- a/aconf/model/field.lua +++ b/aconf/model/field.lua @@ -57,58 +57,6 @@ function M.conv_filter(filter) end - ---- base class for fields. The constructor accepts a table argument --- containing field parameters as key–value pairs. The parameters --- listed below are valid for all subclasses. Subclasses may define --- additional parameters. --- @klass Field --- @tparam ?string addr back-end address for the field. This can be an --- absolute address or relative to the parent's address. The top-level --- component of a back-end address specifies the back-end. The --- interpretation of the remaining components is specific to the --- back-end. If not specified, the address is formed by appending the --- field's name to the address of the parent. --- @param be_mode (optional **string** or --- **{[string]=string,...}**) controls how the Augeas back-end --- will map addresses to Augeas paths. By default, each component of a --- back-end address is directly mapped to an Augeas path --- component. This parameter is an exception table applicable to the --- subtree defined by the field's address. Each key is a relative --- address pattern, and the corresponding value is a directive applied --- to matching address components. The *enumerate* directive indicates --- there can be several Augeas nodes matching the path and the next --- component is to be interpreted as an index for such nodes. The --- *parent-value* directive is applicable only to primitive fields and --- instructs the back-end not to append the last address component at --- all, causing the parent node's value to be accessed. If the --- *be\_mode* parameter is defined as a string, it is assumed to be a --- directive applicable to the field's own address. --- @param choice (optional **{primitive** or --- **{primitive,string},...}**) array of allowed values. Each --- value may be a primitive value or a tuple specifying the value used --- by the data model and a user-friendly value. --- @param compute (optional function(@{node.TreeNode}) --- or **string**) function for computing the value of the field --- when not provided by the back-end. The function gets a reference to --- the field's parent as an argument. If defined as a string, a method --- with the given name is invoked. --- @tparam ?primitive default default value for the field --- @tparam ?boolean required field must be assigned a value if set, --- defaults to false --- @param store (optional function(@{node.TreeNode}, --- primitive) or **string**) if this parameter is --- defined, the value of the field is not stored according to the --- field's back-end address. Rather, the provided function is invoked --- with a reference to the parent and the field value. If defined as a --- string, a method with the given name is invoked. --- @tparam ?string ui_name user-friendly name for the field. --- @tparam ?boolean visible the field is visible in the user interface --- if set, defaults to true --- @tparam ?string widget widget for rendering the field in the user --- interface. The default widget for non-leaf objects is *link*, which --- is a hyperlink to a detailed view to the object. The *inline* --- widget renders a non-leaf object embedded in the parent's view. M.Field = class(M.Member) function M.Field:init(params) @@ -316,8 +264,8 @@ function Primitive:validate(context, value) end ---- string field, inherits @{Field}. --- @klass String +--- string field. +-- @fcons String M.String = class(Primitive) function M.String:init(params) @@ -372,8 +320,8 @@ function M.Integer:validate(context, value) end ---- boolean field, inherits @{Field}. --- @klass Boolean +--- boolean field. +-- @fcons Boolean M.Boolean = class(Primitive) function M.Boolean:init(params) @@ -450,11 +398,11 @@ function M.TreeNode:validate_saved(context) end ---- model field, inherits @{Field}. The value of this field is a --- [model object](#Model_objects) conforming to the specified model. A --- model field with default parameters is implicitly created when a --- model is used in lieu of a @{Field}. --- @klass Model +--- model field. The value of this field is a [model +-- object](#Model_objects) conforming to the specified model. A model +-- field with default parameters is implicitly created when a model is +-- used in lieu of a field. +-- @fcons Model -- @param model ([<Model>](#new)) model describing the -- structure of the model objects M.Model = class(M.TreeNode) -- cgit v1.2.3