diff options
author | Kaarle Ritvanen <kaarle.ritvanen@datakunkku.fi> | 2015-04-02 16:34:13 +0300 |
---|---|---|
committer | Kaarle Ritvanen <kaarle.ritvanen@datakunkku.fi> | 2015-04-03 00:45:53 +0300 |
commit | 3baaf91de453d35b095881478be8d88b3fc2b97a (patch) | |
tree | dbeeedc851f0d8130907574ef8506904c5c44570 /aconf/model/service.lua | |
parent | c7bce46f22ff9c41e3598d42400368d3c733316c (diff) | |
download | aconf-3baaf91de453d35b095881478be8d88b3fc2b97a.tar.bz2 aconf-3baaf91de453d35b095881478be8d88b3fc2b97a.tar.xz |
initial developer documentation
descriptions for all functions and classes used by the openssh module
Diffstat (limited to 'aconf/model/service.lua')
-rw-r--r-- | aconf/model/service.lua | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/aconf/model/service.lua b/aconf/model/service.lua index 2d129fa..9ce3685 100644 --- a/aconf/model/service.lua +++ b/aconf/model/service.lua @@ -3,12 +3,20 @@ Copyright (c) 2012-2015 Kaarle Ritvanen See LICENSE file for license details --]] +--- @module aconf.model + local fld = require('aconf.model.field') local new = require('aconf.model.model').new local super = require('aconf.object').super local pth = require('aconf.path') local store = require('aconf.persistence') +--- create a model corresponding to an OpenRC service. +-- @function service +-- @tparam string name name of the service +-- @treturn Model new model, which has two pre-defined boolean fields, +-- *enabled* and *status*, for controlling the service's lifecycle and +-- inspecting its current status. return function(name) local res = new() |