diff options
author | Petr Vobornik <pvoborni@redhat.com> | 2013-09-06 15:27:06 +0200 |
---|---|---|
committer | Petr Vobornik <pvoborni@redhat.com> | 2013-10-16 18:08:17 +0200 |
commit | efafd7fe871bc368b91db78bb132abb027141a24 (patch) | |
tree | f6d71bae937e31c7090828382af8b404b1ce7e1f /install/ui/src/freeipa/navigation.js | |
parent | 3fa304d95ec59efe0eb1cb8241d88a173802b172 (diff) | |
download | freeipa-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/navigation.js')
-rw-r--r-- | install/ui/src/freeipa/navigation.js | 46 |
1 files changed, 28 insertions, 18 deletions
diff --git a/install/ui/src/freeipa/navigation.js b/install/ui/src/freeipa/navigation.js index 038732cee..8b96d6f97 100644 --- a/install/ui/src/freeipa/navigation.js +++ b/install/ui/src/freeipa/navigation.js @@ -18,15 +18,7 @@ * along with this program. If not, see <http://www.gnu.org/licenses/>. */ -/** - * Navigation tells application to show certain facet. - * - * It's proxy for navigation/Router instance in current running - * application. - * - * Modules just use the interface, they don't have to care about the logic in - * the background. - */ + define([ 'dojo/_base/lang', './app', // creates circular dependency @@ -41,14 +33,25 @@ define([ }, /** + * Navigation tells application to show certain facet. + * + * It's proxy for navigation/Router instance in current running + * application. + * + * Modules just use the interface, they don't have to care about the logic in + * the background. + * @class navigation + */ + + /** * Sets property of params depending on arg type following way: * for String sets params.facet * for Facet sets params.facet (based on show function) * for Object sets params.args * for Array sets params.pkeys - * + * @ignore * @param Object params - * @param {Object|Facet|String|Function} arg + * @param {Object|facet.facet|string|Function} arg */ set_params = function(params, arg) { if (lang.isArray(arg)) { @@ -78,7 +81,10 @@ define([ * * When it's an object (Facet) and has an entity set it will be * dealt as entity facet. - * + * @method show + * @param {Object|facet.facet|string|Function} arg1 + * @param {Object|facet.facet|string|Function} arg2 + * @param {Object|facet.facet|string|Function} arg3 */ show = function(arg1, arg2, arg3) { @@ -111,17 +117,17 @@ define([ }, /** - * Show entity facet. - * - * @param String Enity name - * @param {Object|Facet|String|Function} arg1 - * @param {Object|Facet|String|Function} arg2 - * @param {Object|Facet|String|Function} arg3 + * Show entity facet * * arg1,arg2,arg3 are: * facet name as String * pkeys as Array * args as Object + * @method show_entity + * @param String Enity name + * @param {Object|facet.facet|string|Function} arg1 + * @param {Object|facet.facet|string|Function} arg2 + * @param {Object|facet.facet|string|Function} arg3 */ show_entity = function(entity_name, arg1, arg2, arg3) { var nav = get_router(); @@ -134,6 +140,10 @@ define([ params.pkeys, params.args); }, + /** + * Show default facet + * @method show_default + */ show_default = function() { // TODO: make configurable return show_entity('user', 'search'); |