aboutsummaryrefslogtreecommitdiffstats
path: root/src/ngSanitize/sanitize.js
diff options
context:
space:
mode:
authorAlan Klement2013-05-29 10:44:36 -0300
committerPete Bacon Darwin2013-06-04 21:50:38 +0100
commit681c1c53e40176917ca1c5e9c5b45f45721a210d (patch)
tree31a47a8e37ba16cc0f3428d52284876aa1bdd3ab /src/ngSanitize/sanitize.js
parent631c4863d81a6cfd0eb06b8d664dda8130d3ec9b (diff)
downloadangular.js-681c1c53e40176917ca1c5e9c5b45f45721a210d.tar.bz2
docs(sanitize): add @description section
Diffstat (limited to 'src/ngSanitize/sanitize.js')
-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 677b11d3..94aeef22 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>
*/
/*