diff options
Diffstat (limited to 'aconf/transaction/init.lua')
| -rw-r--r-- | aconf/transaction/init.lua | 11 |
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) |