aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorAlan Klement2013-05-29 10:44:36 -0300
committerPete Bacon Darwin2013-06-04 21:48:39 +0100
commit76cb53f8376a210b13c47dba88f99bbf9170233e (patch)
treea14e08a61ca301d04516a3c9a3e77ae2f0b791db /src
parentef5c874415109a85263ab0f89ba0f56dede8d41c (diff)
downloadangular.js-76cb53f8376a210b13c47dba88f99bbf9170233e.tar.bz2
docs(sanitize): add @description section
Diffstat (limited to 'src')
-rw-r--r--src/ngSanitize/sanitize.js19
1 files changed, 19 insertions, 0 deletions
diff --git a/src/ngSanitize/sanitize.js b/src/ngSanitize/sanitize.js
index 04eafa0d..30de2231 100644
--- a/src/ngSanitize/sanitize.js
+++ b/src/ngSanitize/sanitize.js
@@ -4,6 +4,25 @@
* @ngdoc overview
* @name ngSanitize
* @description
+ *
+ * The `ngSanitize` module provides functionality to sanitize HTML.
+ *
+ * # Installation
+ * As a separate module, it must be loaded after Angular core is loaded; otherwise, an 'Uncaught Error:
+ * No module: ngSanitize' runtime error will occur.
+ *
+ * <pre>
+ * <script src="angular.js"></script>
+ * <script src="angular-sanitize.js"></script>
+ * </pre>
+ *
+ * # Usage
+ * To make sure the module is available to your application, declare it as a dependency of you application
+ * module.
+ *
+ * <pre>
+ * angular.module('app', ['ngSanitize']);
+ * </pre>
*/
/*