diff options
| author | Butch Peters | 2013-09-10 20:13:15 -0500 |
|---|---|---|
| committer | Pete Bacon Darwin | 2013-09-11 12:11:57 +0100 |
| commit | 69dc003a0b488b4c56641bd82a319a16a7cfd859 (patch) | |
| tree | 009f1e70bddfad7e69be8ac9ae8674f22c1a765f | |
| parent | ae2fd55575af2a195f59c3c63224e7be9c0b3c40 (diff) | |
| download | angular.js-69dc003a0b488b4c56641bd82a319a16a7cfd859.tar.bz2 | |
docs(Attributes): add missing documentation for $observe method
- Add proper ngdoc annotations to existing $observe documentation
- Add link to directive guide for usage example of $observe
- Add note about $observe function parameter signature
Closes #3957
| -rw-r--r-- | src/ng/compile.js | 13 |
1 files changed, 11 insertions, 2 deletions
diff --git a/src/ng/compile.js b/src/ng/compile.js index 30d048d4..5cd220ef 100644 --- a/src/ng/compile.js +++ b/src/ng/compile.js @@ -319,12 +319,21 @@ function $CompileProvider($provide) { /** + * @ngdoc function + * @name ng.$compile.directive.Attributes#$observe + * @methodOf ng.$compile.directive.Attributes + * @function + * + * @description * Observe an interpolated attribute. * The observer will never be called, if given attribute is not interpolated. + * The interpolated value of the attribute is passed to the observer function. * * @param {string} key Normalized key. (ie ngAttribute) . - * @param {function(*)} fn Function that will be called whenever the attribute value changes. - * @returns {function(*)} the `fn` Function passed in. + * @param {function(interpolatedValue)} fn Function that will be called whenever + the interpolated value of the attribute changes. + * See the {@link guide/directive#Attributes Directives} guide for more info. + * @returns {function()} the `fn` parameter. */ $observe: function(key, fn) { var attrs = this, |
