aboutsummaryrefslogtreecommitdiffstats
path: root/src/ngSanitize/sanitize.js
diff options
context:
space:
mode:
authorBrian Ford2013-08-22 12:32:42 -0700
committerBrian Ford2013-08-22 16:55:54 -0700
commit57c43dd3762ea665125bff7e4727bce06a225b32 (patch)
tree5002413ad53358a509d881f7999903e01c51f124 /src/ngSanitize/sanitize.js
parent99175f429417318e2087a92dd21bc8d5351c97a3 (diff)
downloadangular.js-57c43dd3762ea665125bff7e4727bce06a225b32.tar.bz2
docs(module): improve the installation instructions for optional modules
Currently, the documentation does a bad job of explaining the distinction between the services that it provides, and the module itself. Furthermore, the instructions for using optional modules are inconsistent or missing. This commit addresses the problem by ading a new `{@installModule foo}` annotation to the docs generator that inlines the appropriate instructions based on the name of the module.
Diffstat (limited to 'src/ngSanitize/sanitize.js')
-rw-r--r--src/ngSanitize/sanitize.js21
1 files changed, 5 insertions, 16 deletions
diff --git a/src/ngSanitize/sanitize.js b/src/ngSanitize/sanitize.js
index 8220b1f5..3d904ad1 100644
--- a/src/ngSanitize/sanitize.js
+++ b/src/ngSanitize/sanitize.js
@@ -6,25 +6,14 @@ var $sanitizeMinErr = angular.$$minErr('$sanitize');
* @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>
+ * # ngSanitize
+ *
+ * The `ngSanitize` module provides functionality to sanitize HTML.
*
- * # Usage
- * To make sure the module is available to your application, declare it as a dependency of you application
- * module.
+ * {@installModule sanitize}
*
- * <pre>
- * angular.module('app', ['ngSanitize']);
- * </pre>
+ * See {@link ngSanitize.$sanitize `$sanitize`} for usage.
*/
/*