diff options
| author |  mitchell <70453897+667e-11@users.noreply.github.com> | 2012-09-12 11:24:11 -0400 |
|---|---|---|
| committer | mitchell <70453897+667e-11@users.noreply.github.com> | 2012-09-12 11:24:11 -0400 |
| commit | 9dc8ce16a1efc6482db6f1d5456d42958e79a06c (patch) | |
| tree | e26ff636143fc74f92a6a3359a73e93194da6bc3 /core/.iconv.luadoc | |
| parent | 4305f32ac153b7a45a1c001da2fcd412af905168 (diff) | |
Documentation overhaul.
Rewrote most of the manual and Lua API to complement each other.
Key bindings reference moved from Appendix to modules/textadept/keys.lua LuaDoc.
Diffstat (limited to 'core/.iconv.luadoc')
| -rw-r--r-- | core/.iconv.luadoc | 6 |
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. |