From 63503bd4517d87c34498002c820aefaef22c501e Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Wed, 22 Aug 2018 15:34:00 +0200 Subject: API documentation for 0.0.17 --- api/pl.treksoft.kvision.i18n/-i18n/gettext.html | 20 ++++++ api/pl.treksoft.kvision.i18n/-i18n/index.html | 89 ++++++++++++++++++++++++ api/pl.treksoft.kvision.i18n/-i18n/init.html | 21 ++++++ api/pl.treksoft.kvision.i18n/-i18n/language.html | 15 ++++ api/pl.treksoft.kvision.i18n/-i18n/ngettext.html | 24 +++++++ api/pl.treksoft.kvision.i18n/-i18n/ntr.html | 24 +++++++ api/pl.treksoft.kvision.i18n/-i18n/tr.html | 20 ++++++ api/pl.treksoft.kvision.i18n/-i18n/trans.html | 22 ++++++ api/pl.treksoft.kvision.i18n/-jed/-init-.html | 14 ++++ api/pl.treksoft.kvision.i18n/-jed/gettext.html | 14 ++++ api/pl.treksoft.kvision.i18n/-jed/index.html | 51 ++++++++++++++ api/pl.treksoft.kvision.i18n/-jed/ngettext.html | 14 ++++ api/pl.treksoft.kvision.i18n/-jed/sprintf.html | 14 ++++ api/pl.treksoft.kvision.i18n/index.html | 33 +++++++++ 14 files changed, 375 insertions(+) create mode 100644 api/pl.treksoft.kvision.i18n/-i18n/gettext.html create mode 100644 api/pl.treksoft.kvision.i18n/-i18n/index.html create mode 100644 api/pl.treksoft.kvision.i18n/-i18n/init.html create mode 100644 api/pl.treksoft.kvision.i18n/-i18n/language.html create mode 100644 api/pl.treksoft.kvision.i18n/-i18n/ngettext.html create mode 100644 api/pl.treksoft.kvision.i18n/-i18n/ntr.html create mode 100644 api/pl.treksoft.kvision.i18n/-i18n/tr.html create mode 100644 api/pl.treksoft.kvision.i18n/-i18n/trans.html create mode 100644 api/pl.treksoft.kvision.i18n/-jed/-init-.html create mode 100644 api/pl.treksoft.kvision.i18n/-jed/gettext.html create mode 100644 api/pl.treksoft.kvision.i18n/-jed/index.html create mode 100644 api/pl.treksoft.kvision.i18n/-jed/ngettext.html create mode 100644 api/pl.treksoft.kvision.i18n/-jed/sprintf.html create mode 100644 api/pl.treksoft.kvision.i18n/index.html (limited to 'api/pl.treksoft.kvision.i18n') diff --git a/api/pl.treksoft.kvision.i18n/-i18n/gettext.html b/api/pl.treksoft.kvision.i18n/-i18n/gettext.html new file mode 100644 index 00000000..63ab9b2b --- /dev/null +++ b/api/pl.treksoft.kvision.i18n/-i18n/gettext.html @@ -0,0 +1,20 @@ + + + +I18n.gettext - kvision + + + +kvision / pl.treksoft.kvision.i18n / I18n / gettext
+
+

gettext

+ +fun gettext(key: String): String +

A static translation function for a singular form.

Parameters

+key - a translation key.

Return
+translated text.

+ + diff --git a/api/pl.treksoft.kvision.i18n/-i18n/index.html b/api/pl.treksoft.kvision.i18n/-i18n/index.html new file mode 100644 index 00000000..a6f2f17e --- /dev/null +++ b/api/pl.treksoft.kvision.i18n/-i18n/index.html @@ -0,0 +1,89 @@ + + + +I18n - kvision + + + +kvision / pl.treksoft.kvision.i18n / I18n
+
+

I18n

+object I18n +

A singleton object used for translations.

Properties

+ + + + + + + +

language

+var language: <ERROR CLASS> +

Main language of the application.

Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ gettext +	+`fun gettext(key: String): String` + A static translation function for a singular form. +
+ init +	+`fun init(vararg languages: String, initCallback: () -> Unit): Unit` + I18n initialization function. +Should be called in the main function of the application. +
+ ngettext +	+`fun ngettext(singularKey: String, pluralKey: String, value: Int): String` + A static translation function for a plural form. +
+ ntr +	+`fun ntr(singularKey: String, pluralKey: String, value: Int): String` + A dynamic translation function for a plural form. +
+ tr +	+`fun tr(key: String): String` + A dynamic translation function for a singular form. +
+ trans +	+`fun trans(text: String): String` +`fun trans(text: String?): String?` + A dynamic translation function. +

+ + diff --git a/api/pl.treksoft.kvision.i18n/-i18n/init.html b/api/pl.treksoft.kvision.i18n/-i18n/init.html new file mode 100644 index 00000000..6e460023 --- /dev/null +++ b/api/pl.treksoft.kvision.i18n/-i18n/init.html @@ -0,0 +1,21 @@ + + + +I18n.init - kvision + + + +kvision / pl.treksoft.kvision.i18n / I18n / init
+
+

init

+ +fun init(vararg languages: String, initCallback: () -> Unit): Unit +

I18n initialization function. +Should be called in the main function of the application.

Parameters

+languages - a list of supported languages.

+initCallback - a code to run after the initialization process is complete.

+ + diff --git a/api/pl.treksoft.kvision.i18n/-i18n/language.html b/api/pl.treksoft.kvision.i18n/-i18n/language.html new file mode 100644 index 00000000..e72498f5 --- /dev/null +++ b/api/pl.treksoft.kvision.i18n/-i18n/language.html @@ -0,0 +1,15 @@ + + + +I18n.language - kvision + + + +kvision / pl.treksoft.kvision.i18n / I18n / language
+
+

language

+ +var language: <ERROR CLASS> +

Main language of the application.

+ + diff --git a/api/pl.treksoft.kvision.i18n/-i18n/ngettext.html b/api/pl.treksoft.kvision.i18n/-i18n/ngettext.html new file mode 100644 index 00000000..091efe53 --- /dev/null +++ b/api/pl.treksoft.kvision.i18n/-i18n/ngettext.html @@ -0,0 +1,24 @@ + + + +I18n.ngettext - kvision + + + +kvision / pl.treksoft.kvision.i18n / I18n / ngettext
+
+

ngettext

+ +fun ngettext(singularKey: String, pluralKey: String, value: Int): String +

A static translation function for a plural form.

Parameters

+singularKey - a translation key for a singular form.

+pluralKey - a translation key for a plural form.

+value - a count value.

Return
+translated text.

+ + diff --git a/api/pl.treksoft.kvision.i18n/-i18n/ntr.html b/api/pl.treksoft.kvision.i18n/-i18n/ntr.html new file mode 100644 index 00000000..958d3c0d --- /dev/null +++ b/api/pl.treksoft.kvision.i18n/-i18n/ntr.html @@ -0,0 +1,24 @@ + + + +I18n.ntr - kvision + + + +kvision / pl.treksoft.kvision.i18n / I18n / ntr
+
+

ntr

+ +fun ntr(singularKey: String, pluralKey: String, value: Int): String +

A dynamic translation function for a plural form.

Parameters

+singularKey - a translation key for a singular form.

+pluralKey - a translation key for a plural form.

+value - a count value.

Return
+text marked for a dynamic translation.

+ + diff --git a/api/pl.treksoft.kvision.i18n/-i18n/tr.html b/api/pl.treksoft.kvision.i18n/-i18n/tr.html new file mode 100644 index 00000000..f419b8b9 --- /dev/null +++ b/api/pl.treksoft.kvision.i18n/-i18n/tr.html @@ -0,0 +1,20 @@ + + + +I18n.tr - kvision + + + +kvision / pl.treksoft.kvision.i18n / I18n / tr
+
+

tr

+ +fun tr(key: String): String +

A dynamic translation function for a singular form.

Parameters

+key - a translation key.

Return
+text marked for a dynamic translation.

+ + diff --git a/api/pl.treksoft.kvision.i18n/-i18n/trans.html b/api/pl.treksoft.kvision.i18n/-i18n/trans.html new file mode 100644 index 00000000..f7fdb811 --- /dev/null +++ b/api/pl.treksoft.kvision.i18n/-i18n/trans.html @@ -0,0 +1,22 @@ + + + +I18n.trans - kvision + + + +kvision / pl.treksoft.kvision.i18n / I18n / trans
+
+

trans

+ +fun trans(text: String): String
+ +fun trans(text: String?): String? +

A dynamic translation function.

Parameters

+text - text marked for a dynamic translation.

Return
+translated text.

+ + diff --git a/api/pl.treksoft.kvision.i18n/-jed/-init-.html b/api/pl.treksoft.kvision.i18n/-jed/-init-.html new file mode 100644 index 00000000..07407dfb --- /dev/null +++ b/api/pl.treksoft.kvision.i18n/-jed/-init-.html @@ -0,0 +1,14 @@ + + + +Jed.<init> - kvision + + + +kvision / pl.treksoft.kvision.i18n / Jed / <init>
+
+

<init>

+ +Jed(json: dynamic) + + diff --git a/api/pl.treksoft.kvision.i18n/-jed/gettext.html b/api/pl.treksoft.kvision.i18n/-jed/gettext.html new file mode 100644 index 00000000..27b56338 --- /dev/null +++ b/api/pl.treksoft.kvision.i18n/-jed/gettext.html @@ -0,0 +1,14 @@ + + + +Jed.gettext - kvision + + + +kvision / pl.treksoft.kvision.i18n / Jed / gettext
+
+

gettext

+ +fun gettext(key: String): String + + diff --git a/api/pl.treksoft.kvision.i18n/-jed/index.html b/api/pl.treksoft.kvision.i18n/-jed/index.html new file mode 100644 index 00000000..1dbda76c --- /dev/null +++ b/api/pl.treksoft.kvision.i18n/-jed/index.html @@ -0,0 +1,51 @@ + + + +Jed - kvision + + + +kvision / pl.treksoft.kvision.i18n / Jed
+
+

Jed

+external class Jed +

Constructors

+ + + + + + + +

<init>

+Jed(json: dynamic)

Functions

+ + + + + + + + + + + + + + + +

+ gettext +	+`fun gettext(key: String): String`
+ ngettext +	+`fun ngettext(singularKey: String, pluralKey: String, value: Int): String`
+ sprintf +	+`fun sprintf(format: String, value: Int): String`

+ + diff --git a/api/pl.treksoft.kvision.i18n/-jed/ngettext.html b/api/pl.treksoft.kvision.i18n/-jed/ngettext.html new file mode 100644 index 00000000..1af03cfa --- /dev/null +++ b/api/pl.treksoft.kvision.i18n/-jed/ngettext.html @@ -0,0 +1,14 @@ + + + +Jed.ngettext - kvision + + + +kvision / pl.treksoft.kvision.i18n / Jed / ngettext
+
+

ngettext

+ +fun ngettext(singularKey: String, pluralKey: String, value: Int): String + + diff --git a/api/pl.treksoft.kvision.i18n/-jed/sprintf.html b/api/pl.treksoft.kvision.i18n/-jed/sprintf.html new file mode 100644 index 00000000..662f686a --- /dev/null +++ b/api/pl.treksoft.kvision.i18n/-jed/sprintf.html @@ -0,0 +1,14 @@ + + + +Jed.sprintf - kvision + + + +kvision / pl.treksoft.kvision.i18n / Jed / sprintf
+
+

sprintf

+ +fun sprintf(format: String, value: Int): String + + diff --git a/api/pl.treksoft.kvision.i18n/index.html b/api/pl.treksoft.kvision.i18n/index.html new file mode 100644 index 00000000..bce054ea --- /dev/null +++ b/api/pl.treksoft.kvision.i18n/index.html @@ -0,0 +1,33 @@ + + + +pl.treksoft.kvision.i18n - kvision + + + +kvision / pl.treksoft.kvision.i18n
+
+

Package pl.treksoft.kvision.i18n

Types

+ + + + + + + + + + + +

+ I18n +	+`object I18n` + A singleton object used for translations. +
+ Jed +	+`external class Jed`

+ + -- cgit