From efafd7fe871bc368b91db78bb132abb027141a24 Mon Sep 17 00:00:00 2001
From: Petr Vobornik <pvoborni@redhat.com>
Date: Fri, 6 Sep 2013 15:27:06 +0200
Subject: 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.
---
 install/ui/src/freeipa/text.js | 20 ++++++++++++++------
 1 file changed, 14 insertions(+), 6 deletions(-)

(limited to 'install/ui/src/freeipa/text.js')

diff --git a/install/ui/src/freeipa/text.js b/install/ui/src/freeipa/text.js
index a439237a..776b9ee0 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,
-- 
cgit