aboutsummaryrefslogtreecommitdiffhomepage
path: root/core/.iconv.luadoc
diff options
context:
space:
mode:
authorGravatar mitchell <70453897+orbitalquark@users.noreply.github.com>2021-04-11 09:34:17 -0400
committerGravatar mitchell <70453897+orbitalquark@users.noreply.github.com>2021-04-11 09:34:17 -0400
commitde3a745e1af2e441de868c2aa4849102d376acb5 (patch)
treec2d7767600dc519b2613ddecaf7e53fb5e8867a2 /core/.iconv.luadoc
parent03fab17277fee7387fd93a9c2774b1ebf3f80fe4 (diff)
Initial pass reformatting all code.
Use clang-format, LuaFormatter, and 100 character limit on lines.
Diffstat (limited to 'core/.iconv.luadoc')
-rw-r--r--core/.iconv.luadoc27
1 files changed, 12 insertions, 15 deletions
diff --git a/core/.iconv.luadoc b/core/.iconv.luadoc
index adaeaea3..89471c59 100644
--- a/core/.iconv.luadoc
+++ b/core/.iconv.luadoc
@@ -1,26 +1,23 @@
-- Copyright 2007-2020 Mitchell. See LICENSE.
--- This is a DUMMY FILE used for making LuaDoc for built-in functions in the
--- string table.
+-- This is a DUMMY FILE used for making LuaDoc for built-in functions in the string table.
--- Extends Lua's `string` library to provide character set conversions.
module('string')
---
--- Converts string *text* from encoding *old* to encoding *new* using GNU
--- libiconv, returning the string result.
+-- Converts string *text* from encoding *old* to encoding *new* using GNU libiconv, returning
+-- the string result.
-- Raises an error if the encoding conversion failed.
-- Valid encodings are [GNU libiconv's encodings][] 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.
+-- * 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.
+-- * 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.
@@ -29,8 +26,8 @@ module('string')
-- * 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.
+-- * 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 libiconv's encodings]: https://www.gnu.org/software/libiconv/
-- @param text The text to convert.