From 3069566073ef07700dc29714f74dd6f2069caf90 Mon Sep 17 00:00:00 2001 From: Igor Minar Date: Mon, 6 Jun 2011 14:44:49 -0700 Subject: api doc fixes from ken --- src/widgets.js | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) (limited to 'src/widgets.js') diff --git a/src/widgets.js b/src/widgets.js index 1cd7211f..c923b551 100644 --- a/src/widgets.js +++ b/src/widgets.js @@ -1,3 +1,30 @@ +/** + * @workInProgress + * @ngdoc overview + * @name angular.widget + * @description + * + * Widgets are custom DOM elements. An angular widget can be either a custom + * attribute that modifies an existing DOM elements or an entirely new DOM element. + * + * Following is the list of built-in angular widgets: + * + * * {@link angular.Widget.@ng:format ng:format} - Formats data for display to user and for storage. + * * {@link angular.Widget.@ng:non-bindable ng:non-bindable} - Blocks angular from processing an + * HTML element. + * * {@link angular.Widget.@ng:repeat ng:repeat} - Creates and manages a collection of cloned HTML + * elements. + * * {@link angular.Widget.@ng:required ng:required} - Verifies presence of user input. + * * {@link angular.Widget.@ng:validate ng:validate} - Validates content of user input. + * * {@link angular.Widget.HTML HTML} - Standard HTML processed by angular. + * * {@link angular.Widget.ng:view ng:view} - Works with $route to "include" partial templates + * * {@link angular.Widget.ng:switch ng:switch} - Conditionally changes DOM structure + * * {@link angular.Widget.ng:include ng:include} - Includes an external HTML fragment + * + * For more information about angular widgets, see {@link guide/widgets Understanding Angular + * Widgets} in the angular Developer Guide. + */ + /** * @workInProgress * @ngdoc widget -- cgit v1.2.3