aboutsummaryrefslogtreecommitdiff
path: root/core/.iconv.luadoc
blob: 7e9f9aee71b6f90079698a9d1f5a2663da301038 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
-- Copyright 2007-2012 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