summaryrefslogtreecommitdiffstats
path: root/install/ui/src/freeipa/text.js
diff options
context:
space:
mode:
authorPetr Vobornik <pvoborni@redhat.com>2013-09-06 15:27:06 +0200
committerPetr Vobornik <pvoborni@redhat.com>2013-10-16 18:08:17 +0200
commitefafd7fe871bc368b91db78bb132abb027141a24 (patch)
treef6d71bae937e31c7090828382af8b404b1ce7e1f /install/ui/src/freeipa/text.js
parent3fa304d95ec59efe0eb1cb8241d88a173802b172 (diff)
downloadfreeipa-efafd7fe871bc368b91db78bb132abb027141a24.tar.gz
freeipa-efafd7fe871bc368b91db78bb132abb027141a24.tar.xz
freeipa-efafd7fe871bc368b91db78bb132abb027141a24.zip
Web UI source code annotation
Part of ongoing Web UI documentation effort. Source code is annotated in a way that it can be processed by documentation generator.
Diffstat (limited to 'install/ui/src/freeipa/text.js')
-rw-r--r--install/ui/src/freeipa/text.js20
1 files changed, 14 insertions, 6 deletions
diff --git a/install/ui/src/freeipa/text.js b/install/ui/src/freeipa/text.js
index a439237ae..776b9ee0d 100644
--- a/install/ui/src/freeipa/text.js
+++ b/install/ui/src/freeipa/text.js
@@ -18,15 +18,23 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-/**
- * Text provider
- *
- * Serves for returning labels, titles, messages from various providers.
- * Other providers can extends functionality.
- */
define(['./_base/Provider', './_base/i18n', './metadata'],
function(Provider, i18n, metadata) {
+ /**
+ * Text provider
+ *
+ * Serves for returning labels, titles, messages from:
+ *
+ * - {@link _base.i18n} provider
+ * - and {@link metadata} provider
+ *
+ * Other providers can extends its functionality.
+ *
+ * @class text
+ * @singleton
+ * @extends _base.Provider
+ */
var text = new Provider({
providers: [
i18n,