Skip to content
This repository has been archived by the owner on Apr 12, 2024. It is now read-only.

Commit

Permalink
docs(scope): show which directives create scopes
Browse files Browse the repository at this point in the history
  • Loading branch information
mhevery committed Feb 22, 2012
1 parent fbcb7fd commit c27a56f
Show file tree
Hide file tree
Showing 5 changed files with 45 additions and 3 deletions.
20 changes: 20 additions & 0 deletions docs/spec/ngdocSpec.js
Original file line number Diff line number Diff line change
Expand Up @@ -349,6 +349,26 @@ describe('ngdoc', function() {
});
});

describe('@scope', function() {
it('should state the new scope will be created', function() {
var doc = new Doc('@name a\n@scope');
doc.ngdoc = 'directive';
doc.parse();
expect(doc.scope).toEqual('');
expect(doc.html()).toContain('This directive creates new scope.');
});
});

describe('@priority', function() {
it('should state the priority', function() {
var doc = new Doc('@name a\n@priority 123');
doc.ngdoc = 'directive';
doc.parse();
expect(doc.priority).toEqual('123');
expect(doc.html()).toContain('This directive executes at priority level 123.');
});
});

describe('@property', function() {
it('should parse @property tags into array', function() {
var doc = new Doc("@name a\n@property {type} name1 desc\n@property {type} name2 desc");
Expand Down
17 changes: 16 additions & 1 deletion docs/src/ngdoc.js
Original file line number Diff line number Diff line change
Expand Up @@ -374,6 +374,7 @@ Doc.prototype = {
dom.text('>\n ...\n');
dom.text('</' + self.element + '>');
});
self.html_usage_directiveInfo(dom);
self.html_usage_parameters(dom);
});
},
Expand Down Expand Up @@ -461,11 +462,25 @@ Doc.prototype = {
});
});

self.html_usage_directiveInfo(dom);
self.html_usage_parameters(dom);
self.html_usage_returns(dom);
});
},

html_usage_directiveInfo: function(dom) {
var self = this;
var list = [];


if (self.scope !== undefined) {
list.push('This directive creates new scope.');
}
if (self.priority !== undefined) {
list.push('This directive executes at priority level ' + self.priority + '.');
}
dom.ul(list);
},

html_usage_overview: function(dom){
dom.html(this.description);
},
Expand Down
1 change: 1 addition & 0 deletions src/directives.js
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ var ngInitDirective = valueFn({
* service.
*
* @element ANY
* @scope
* @param {expression} expression Name of a globally accessible constructor function or an
* {@link guide/dev_guide.expressions expression} that on the current scope evaluates to a
* constructor function.
Expand Down
3 changes: 2 additions & 1 deletion src/widget/form.js
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
'use strict';

/**
* @ngdoc widget
* @ngdoc directive
* @name angular.module.ng.$compileProvider.directive.form
*
* @scope
* @description
* Angular widget that creates a form scope using the
* {@link angular.module.ng.$formFactory $formFactory} API. The resulting form scope instance is
Expand Down
7 changes: 6 additions & 1 deletion src/widgets.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@
* Keep in mind that Same Origin Policy applies to included resources
* (e.g. ng:include won't work for file:// access).
*
* @scope
*
* @param {string} src angular expression evaluating to URL. If the source is a string constant,
* make sure you wrap it in quotes, e.g. `src="'myPartialTemplate.html'"`.
* @param {Scope=} [scope=new_child_scope] optional expression which evaluates to an
Expand Down Expand Up @@ -130,6 +132,7 @@ var ngIncludeDirective = ['$http', '$templateCache', '$anchorScroll', '$compile'
* ...
* <any ng:switch-default>...</any>
*
* @scope
* @param {*} on expression to match against <tt>ng:switch-when</tt>.
* @paramDescription
* On child elments add:
Expand Down Expand Up @@ -254,7 +257,7 @@ var htmlAnchorDirective = valueFn({


/**
* @ngdoc widget
* @ngdoc directive
* @name angular.module.ng.$compileProvider.directive.ng:repeat
*
* @description
Expand All @@ -273,6 +276,8 @@ var htmlAnchorDirective = valueFn({
* Note: Although `ng:repeat` looks like a directive, it is actually an attribute widget.
*
* @element ANY
* @scope
* @priority 1000
* @param {string} repeat_expression The expression indicating how to enumerate a collection. Two
* formats are currently supported:
*
Expand Down

0 comments on commit c27a56f

Please sign in to comment.