X-Git-Url: http://git.archive.openwrt.org/?a=blobdiff_plain;f=modules%2Fluci-base%2Fluasrc%2Futil.luadoc;h=79a17a2280483f4cb66349ea8e4db5f2636b2c10;hb=48a5864f06528e5e454f6e009ec863122f997415;hp=1c09b7a9ab58f1e613f56bc25bb9a0ee02d7dcbe;hpb=84346cd178ca0740817edc6f81d8f90e7bc6e00c;p=project%2Fluci.git diff --git a/modules/luci-base/luasrc/util.luadoc b/modules/luci-base/luasrc/util.luadoc index 1c09b7a9a..79a17a228 100644 --- a/modules/luci-base/luasrc/util.luadoc +++ b/modules/luci-base/luasrc/util.luadoc @@ -1,8 +1,7 @@ ---[[ LuCI utility functions. - -module "luci.util" ]] +module "luci.util" ---[[ Create a Class object (Python-style object model). @@ -84,6 +83,15 @@ Strip HTML tags from given string. ]] ---[[ +Safely quote value for use in shell commands. + +@class function +@name shellquote +@param value String containing the value to quote +@return Single-quote enclosed string with embedded quotes escaped +]] + +---[[ Splits given string on a defined separator sequence and return a table containing the resulting substrings. The optional max parameter specifies @@ -110,13 +118,13 @@ Remove leading and trailing whitespace from given string value. ]] ---[[ -Count the occurences of given substring in given string. +Count the occurrences of given substring in given string. @class function @name cmatch @param str String to search in @param pattern String containing pattern to find -@return Number of found occurences +@return Number of found occurrences ]] ---[[ @@ -182,7 +190,8 @@ Checks whether the given table contains the given value. @name contains @param table Table value @param value Value to search within the given table -@return Boolean indicating whether the given value occurs within table +@return number indicating the first index at which the given value occurs +-- within table or false. ]] ---[[