From: Steven Barth <steven@midlink.org>
Date: Wed, 23 Jul 2008 14:17:37 +0000 (+0000)
Subject: libs/core: Update luci.sys inline documentation
X-Git-Tag: 0.8.0~586
X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=c5a68895cff827abcc641ea0619a703413d5abe6;p=oweals%2Fluci.git

libs/core: Update luci.sys inline documentation
---

diff --git a/libs/core/luasrc/sys.lua b/libs/core/luasrc/sys.lua
index 45e44b80d..217a36b0f 100644
--- a/libs/core/luasrc/sys.lua
+++ b/libs/core/luasrc/sys.lua
@@ -71,7 +71,7 @@ function execl(command)
 end
 
 --- Invoke the luci-flash executable to write an image to the flash memory.
--- @param kpattern	kpattern (ToDo: clearify this)
+-- @param kpattern	Pattern of files to keep over flash process
 -- @return			Return value of os.execute()
 function flash(image, kpattern)
 	local cmd = "luci-flash "
@@ -202,9 +202,14 @@ function uptime()
 	return loadavg:match("^(.-) (.-)$")
 end
 
---- Get group information
--- @return	Group (ToDo: clearify)
+--- LuCI system utilities / POSIX user group related functions.
+-- @class	module
+-- @name	luci.sys.group
 group = {}
+
+--- Returns information about a POSIX user group.
+-- @param group Group ID or name of a system user group
+-- @return	Table with information about the requested group
 group.getgroup = posix.getgroup