aboutsummaryrefslogtreecommitdiffhomepage
path: root/core/.iconv.luadoc
diff options
context:
space:
mode:
authorGravatar mitchell <70453897+667e-11@users.noreply.github.com>2012-11-19 23:53:30 -0500
committerGravatar mitchell <70453897+667e-11@users.noreply.github.com>2012-11-19 23:53:30 -0500
commit5f98f4e9afdc411dd492d103ff7e26c258d9b935 (patch)
treea774d8090f3e6fcbe017b9d1d65307b6da2a8e50 /core/.iconv.luadoc
parent9cdaf41a724dd0d739611c698e92f4421a2fbafc (diff)
Rewrote LuaDoc.
Diffstat (limited to 'core/.iconv.luadoc')
-rw-r--r--core/.iconv.luadoc26
1 files changed, 24 insertions, 2 deletions
diff --git a/core/.iconv.luadoc b/core/.iconv.luadoc
index 78616a30..b21f6c5a 100644
--- a/core/.iconv.luadoc
+++ b/core/.iconv.luadoc
@@ -6,8 +6,30 @@
module('string')
---
--- Converts a string from one character set to another using iconv.
--- Valid character sets are [GNU iconv's character sets][].
+-- Converts string *text* from character set *from* to character set *to* using
+-- iconv.
+-- Valid character sets are [GNU iconv's character sets][] and include:
+--
+-- * European: ASCII, ISO-8859-{1,2,3,4,5,7,9,10,13,14,15,16}, KOI8-R, KOI8-U,
+-- KOI8-RU, CP{1250,1251,1252,1253,1254,1257}, CP{850,866,1131},
+-- Mac{Roman,CentralEurope,Iceland,Croatian,Romania},
+-- Mac{Cyrillic,Ukraine,Greek,Turkish}, Macintosh.
+-- * Semitic: ISO-8859-{6,8}, CP{1255,1256}, CP862, Mac{Hebrew,Arabic}.
+-- * Japanese: EUC-JP, SHIFT_JIS, CP932, ISO-2022-JP, ISO-2022-JP-2,
+-- ISO-2022-JP-1.
+-- * Chinese: EUC-CN, HZ, GBK, CP936, GB18030, EUC-TW, BIG5, CP950,
+-- BIG5-HKSCS, BIG5-HKSCS:2004, BIG5-HKSCS:2001, BIG5-HKSCS:1999,
+-- ISO-2022-CN, ISO-2022-CN-EXT.
+-- * Korean: EUC-KR, CP949, ISO-2022-KR, JOHAB.
+-- * Armenian: ARMSCII-8.
+-- * Georgian: Georgian-Academy, Georgian-PS.
+-- * Tajik: KOI8-T.
+-- * Kazakh: PT154, RK1048.
+-- * Thai: ISO-8859-11, TIS-620, CP874, MacThai.
+-- * Laotian: MuleLao-1, CP1133.
+-- * Vietnamese: VISCII, TCVN, CP1258.
+-- * Unicode: UTF-8, UCS-2, UCS-2BE, UCS-2LE, UCS-4, UCS-4BE, UCS-4LE, UTF-16,
+-- UTF-16BE, UTF-16LE, UTF-32, UTF-32BE, UTF-32LE, UTF-7, C99, JAVA.
--
-- [GNU iconv's character sets]: http://www.gnu.org/software/libiconv/
-- @param text The text to convert.