summaryrefslogtreecommitdiffhomepage
path: root/modules/luci-base/luasrc/model/uci.luadoc
diff options
context:
space:
mode:
authorJo-Philipp Wich <jow@openwrt.org>2015-11-16 12:36:29 +0100
committerJo-Philipp Wich <jow@openwrt.org>2015-11-16 12:37:23 +0100
commit092d2143bd452708fe3ce8e5c6a6cfe133ee24c9 (patch)
treed851a7797b60331843bac6110804526dc2105648 /modules/luci-base/luasrc/model/uci.luadoc
parent1106b9346a776bfed6307e6df601781becbe41f5 (diff)
luci-base: fix uci documentation issue (#538)
Signed-off-by: Jo-Philipp Wich <jow@openwrt.org>
Diffstat (limited to 'modules/luci-base/luasrc/model/uci.luadoc')
-rw-r--r--modules/luci-base/luasrc/model/uci.luadoc8
1 files changed, 7 insertions, 1 deletions
diff --git a/modules/luci-base/luasrc/model/uci.luadoc b/modules/luci-base/luasrc/model/uci.luadoc
index 80464f7cec..7591b68b02 100644
--- a/modules/luci-base/luasrc/model/uci.luadoc
+++ b/modules/luci-base/luasrc/model/uci.luadoc
@@ -235,12 +235,18 @@ Saves changes made to a config to make them committable.
---[[
Set a value or create a named section.
+When invoked with three arguments `config`, `sectionname`, `sectiontype`,
+then a named section of the given type is created.
+
+When invoked with four arguments `config`, `sectionname`, `optionname` and
+`optionvalue` then the value of the specified option is set to the given value.
+
@class function
@name Cursor.set
@param config UCI config
@param section UCI section name
@param option UCI option or UCI section type
-@param value UCI value or nil if you want to create a section
+@param value UCI value or nothing if you want to create a section
@return Boolean whether operation succeeded
]]