summaryrefslogtreecommitdiffstats
path: root/aconf/transaction/init.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/transaction/init.lua
parent88a2ee4783d15c74f735f26c48b621b5e848d334 (diff)
downloadaconf-cc8acc5fa708b9f24369d71b5e982a0314ca64d7.tar.bz2
aconf-cc8acc5fa708b9f24369d71b5e982a0314ca64d7.tar.xz
doc: describe functionality used in the network module
Diffstat (limited to 'aconf/transaction/init.lua')
-rw-r--r--aconf/transaction/init.lua11
1 files changed, 10 insertions, 1 deletions
diff --git a/aconf/transaction/init.lua b/aconf/transaction/init.lua
index 2aabec5..5c71ce8 100644
--- a/aconf/transaction/init.lua
+++ b/aconf/transaction/init.lua
@@ -1,8 +1,10 @@
--[[
-Copyright (c) 2012-2015 Kaarle Ritvanen
+Copyright (c) 2012-2016 Kaarle Ritvanen
See LICENSE file for license details
--]]
+--- @module aconf.model
+
local ErrorDict = require('aconf.error').ErrorDict
local root = require('aconf.model.root')
@@ -15,6 +17,9 @@ local util = require('aconf.util')
local copy = util.copy
+--- Transaction objects. These objects represent and ongoing
+-- transaction.
+-- @section ModelTransaction
local ModelTransaction = object.class(
require('aconf.transaction.base').Transaction
)
@@ -38,6 +43,10 @@ function ModelTransaction:check()
if not self.backend then error('Transaction already committed') end
end
+--- fetch an object.
+-- @function get
+-- @tparam string path object path
+-- @treturn primitive|node.TreeNode object
function ModelTransaction:get(path)
self:check()
return super(self, ModelTransaction):get(path)