aboutsummaryrefslogtreecommitdiff
path: root/core/.iconv.luadoc
blob: 78616a30400606ea08424210ba85e81047799b39 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
-- Copyright 2007-2012 Mitchell mitchell.att.foicica.com. See LICENSE.
-- 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 a string from one character set to another using iconv.
-- 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.
function iconv(text, to, from) end