Skip to content

Commit 76cb53f

Browse files
Alan Klementpetebacondarwin
Alan Klement
authored andcommitted
docs(sanitize): add @description section
1 parent ef5c874 commit 76cb53f

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

src/ngSanitize/sanitize.js

+19
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,25 @@
44
* @ngdoc overview
55
* @name ngSanitize
66
* @description
7+
*
8+
* The `ngSanitize` module provides functionality to sanitize HTML.
9+
*
10+
* # Installation
11+
* As a separate module, it must be loaded after Angular core is loaded; otherwise, an 'Uncaught Error:
12+
* No module: ngSanitize' runtime error will occur.
13+
*
14+
* <pre>
15+
* <script src="angular.js"></script>
16+
* <script src="angular-sanitize.js"></script>
17+
* </pre>
18+
*
19+
* # Usage
20+
* To make sure the module is available to your application, declare it as a dependency of you application
21+
* module.
22+
*
23+
* <pre>
24+
* angular.module('app', ['ngSanitize']);
25+
* </pre>
726
*/
827

928
/*

0 commit comments

Comments
 (0)