aboutsummaryrefslogtreecommitdiff
path: root/core/.iconv.luadoc
diff options
context:
space:
mode:
Diffstat (limited to 'core/.iconv.luadoc')
-rw-r--r--core/.iconv.luadoc6
1 files changed, 4 insertions, 2 deletions
diff --git a/core/.iconv.luadoc b/core/.iconv.luadoc
index eb761d56..fcf199ca 100644
--- a/core/.iconv.luadoc
+++ b/core/.iconv.luadoc
@@ -2,12 +2,14 @@
-- 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.
+--- 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 GNU iconv's character sets.
+-- Valid character sets are [GNU iconv's character sets][].
+--
+-- [GNU iconv's character sets]: http://www.gnu.org/software/libiconv/
-- @param text The text to convert.
-- @param to The character set to convert to.
-- @param from The character set to convert from.