From 3baaf91de453d35b095881478be8d88b3fc2b97a Mon Sep 17 00:00:00 2001 From: Kaarle Ritvanen Date: Thu, 2 Apr 2015 16:34:13 +0300 Subject: initial developer documentation descriptions for all functions and classes used by the openssh module --- aconf/model/service.lua | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'aconf/model/service.lua') 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() -- cgit v1.2.3