summaryrefslogtreecommitdiffstats
path: root/aconf/model/field.lua
diff options
context:
space:
mode:
authorKaarle Ritvanen <kaarle.ritvanen@datakunkku.fi>2016-12-09 19:50:10 +0200
committerKaarle Ritvanen <kaarle.ritvanen@datakunkku.fi>2016-12-19 22:40:51 +0200
commitcc8acc5fa708b9f24369d71b5e982a0314ca64d7 (patch)
tree4bbbe8eb323a8bf725f11c4081e9940779f2d43d /aconf/model/field.lua
parent88a2ee4783d15c74f735f26c48b621b5e848d334 (diff)
downloadaconf-cc8acc5fa708b9f24369d71b5e982a0314ca64d7.tar.bz2
aconf-cc8acc5fa708b9f24369d71b5e982a0314ca64d7.tar.xz
doc: describe functionality used in the network module
Diffstat (limited to 'aconf/model/field.lua')
-rw-r--r--aconf/model/field.lua7
1 files changed, 6 insertions, 1 deletions
diff --git a/aconf/model/field.lua b/aconf/model/field.lua
index cd849e2..414cd62 100644
--- a/aconf/model/field.lua
+++ b/aconf/model/field.lua
@@ -3,7 +3,12 @@ Copyright (c) 2012-2016 Kaarle Ritvanen
See LICENSE file for license details
--]]
---- Alpine Configurator data model.
+--- Alpine Configurator (aconf) data model. This module is imported by
+-- all aconf modules. The aconf modules are installed to
+-- */usr/share/aconf/aconf/modules* and imported automatically from
+-- there. On import, the module may return an initialization function,
+-- which receives a [transaction object](#Transaction_objects) as an
+-- argument.
-- @module aconf.model
local M = {}