diff options
Diffstat (limited to 'modules/luci-base/luasrc/i18n.luadoc')
| -rw-r--r-- | modules/luci-base/luasrc/i18n.luadoc | 56 |
1 files changed, 7 insertions, 49 deletions
diff --git a/modules/luci-base/luasrc/i18n.luadoc b/modules/luci-base/luasrc/i18n.luadoc index aa38841e17..b76c298565 100644 --- a/modules/luci-base/luasrc/i18n.luadoc +++ b/modules/luci-base/luasrc/i18n.luadoc @@ -4,40 +4,12 @@ LuCI translation library. module "luci.i18n" ---[[ -Clear the translation table. - - -@class function -@name clear -]] - ----[[ -Load a translation and copy its data into the translation table. - -@class function -@name load -@param file Language file -@param lang Two-letter language code -@param force Force reload even if already loaded (optional) -@return Success status -]] - ----[[ -Load a translation file using the default translation language. - -Alternatively load the translation of the fallback language. -@class function -@name loadc -@param file Language file -@param force Force reload even if already loaded (optional) -]] - ----[[ Set the context default translation language. @class function @name setlanguage -@param lang Two-letter language code +@param lang An IETF/BCP 47 language tag or ISO3166 country code, e.g. "en-US" or "de" +@return The effective loaded language, e.g. "en" for "en-US" - or nil on failure ]] ---[[ @@ -60,25 +32,11 @@ Return the translated value for a specific translation key and use it as sprintf ]] ---[[ -Return the translated value for a specific translation key +Return all currently loaded translation strings as a key-value table. The key is the +hexadecimal representation of the translation key while the value is the translated +text content. -and ensure that the returned value is a Lua string value. -This is the same as calling <code>tostring(translate(...))</code> @class function -@name string -@param key Default translation text -@return Translated string +@name dump +@return Key-value translation string table. ]] - ----[[ -Return the translated value for a specific translation key and use it as sprintf pattern. - -Ensure that the returned value is a Lua string value. -This is the same as calling <code>tostring(translatef(...))</code> -@class function -@name stringf -@param key Default translation text -@param ... Format parameters -@return Translated and formatted string -]] - |