aboutsummaryrefslogtreecommitdiffhomepage
path: root/core/.iconv.luadoc
diff options
context:
space:
mode:
Diffstat (limited to 'core/.iconv.luadoc')
-rw-r--r--core/.iconv.luadoc15
1 files changed, 15 insertions, 0 deletions
diff --git a/core/.iconv.luadoc b/core/.iconv.luadoc
new file mode 100644
index 00000000..86ca54c9
--- /dev/null
+++ b/core/.iconv.luadoc
@@ -0,0 +1,15 @@
+-- Copyright 2007-2010 Mitchell mitchell<att>caladbolg.net. See LICENSE.
+-- This is a DUMMY FILE used for making LuaDoc for built-in functions in the
+-- string table.
+
+--- Extends Lua's string package to provide character set conversions.
+module('string')
+
+---
+-- Converts a string from one character set to another using iconv().
+-- Valid character sets are ones GLib's g_convert() accepts, typically GNU
+-- iconv's character sets.
+-- @param text The text to convert.
+-- @param to The character set to convert to.
+-- @param from The character set to convert from.
+function iconv(text, to, from) end