diff options
| author | Jo-Philipp Wich <jow@openwrt.org> | 2015-11-16 12:36:29 +0100 |
|---|---|---|
| committer | Jo-Philipp Wich <jow@openwrt.org> | 2015-11-16 12:37:23 +0100 |
| commit | 092d2143bd452708fe3ce8e5c6a6cfe133ee24c9 (patch) | |
| tree | d851a7797b60331843bac6110804526dc2105648 | |
| parent | 1106b9346a776bfed6307e6df601781becbe41f5 (diff) | |
luci-base: fix uci documentation issue (#538)
Signed-off-by: Jo-Philipp Wich <jow@openwrt.org>
| -rw-r--r-- | documentation/api/modules/luci.model.uci.html | 8 | ||||
| -rw-r--r-- | modules/luci-base/luasrc/model/uci.luadoc | 8 |
2 files changed, 14 insertions, 2 deletions
diff --git a/documentation/api/modules/luci.model.uci.html b/documentation/api/modules/luci.model.uci.html index 9e50d9900..cf75aebcc 100644 --- a/documentation/api/modules/luci.model.uci.html +++ b/documentation/api/modules/luci.model.uci.html @@ -1119,6 +1119,12 @@ Name of created section Set a value or create a named section. + +When invoked with three arguments <code>config</code>, <code>sectionname</code>, <code>sectiontype</code>, +then a named section of the given type is created. + +When invoked with four arguments <code>config</code>, <code>sectionname</code>, <code>optionname</code> and +<code>optionvalue</code> then the value of the specified option is set to the given value. @@ -1138,7 +1144,7 @@ Set a value or create a named section. </li> <li> - value: UCI value or nil if you want to create a section + value: UCI value or nothing if you want to create a section </li> </ul> diff --git a/modules/luci-base/luasrc/model/uci.luadoc b/modules/luci-base/luasrc/model/uci.luadoc index 80464f7ce..7591b68b0 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 ]] |