summaryrefslogtreecommitdiffhomepage
path: root/modules/luci-base/luasrc/xml.luadoc
diff options
context:
space:
mode:
authorSven Roederer <freifunk@it-solutions.geroedel.de>2019-07-06 14:18:15 +0200
committerJo-Philipp Wich <jo@mein.io>2020-07-19 20:14:35 +0200
commit68521fca04e9b2ae801cc2daa4f920a2c43bc03f (patch)
treec156d044c3f3ed1e970b0398045ead3624c75b12 /modules/luci-base/luasrc/xml.luadoc
parent8b8d83e42dd3d10d82e29a8614a7b3e3e94b16c6 (diff)
luci-base(-libs): move pcdata() and striptags() from util- to xml-class
To complete the previous commit these functions are defined in the resulting luci-base package but are also used in the new luci-base-libs package. So move them into the new xml-module of the new package. Signed-off-by: Sven Roederer <freifunk@it-solutions.geroedel.de>
Diffstat (limited to 'modules/luci-base/luasrc/xml.luadoc')
-rw-r--r--modules/luci-base/luasrc/xml.luadoc23
1 files changed, 23 insertions, 0 deletions
diff --git a/modules/luci-base/luasrc/xml.luadoc b/modules/luci-base/luasrc/xml.luadoc
new file mode 100644
index 000000000..58de53396
--- /dev/null
+++ b/modules/luci-base/luasrc/xml.luadoc
@@ -0,0 +1,23 @@
+---[[
+LuCI utility functions.
+]]
+module "luci.xml"
+
+---[[
+Create valid XML PCDATA from given string.
+
+@class function
+@name pcdata
+@param value String value containing the data to escape
+@return String value containing the escaped data
+]]
+
+---[[
+Strip HTML tags from given string.
+
+@class function
+@name striptags
+@param value String containing the HTML text
+@return String with HTML tags stripped of
+]]
+