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

Commit 9a21050

Browse files
dbinitbtford
authored andcommitted
docs(angular.Module): fix controller and directive method parameters
1 parent 8473b9d commit 9a21050

File tree

3 files changed

+11
-7
lines changed

3 files changed

+11
-7
lines changed

src/loader.js

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,8 @@ function setupModuleLoader(window) {
178178
* @ngdoc method
179179
* @name angular.Module#controller
180180
* @methodOf angular.Module
181-
* @param {string} name Controller name.
181+
* @param {string|Object} name Controller name, or an object map of controllers where the
182+
* keys are the names and the values are the constructors.
182183
* @param {Function} constructor Controller constructor function.
183184
* @description
184185
* See {@link ng.$controllerProvider#register $controllerProvider.register()}.
@@ -189,7 +190,8 @@ function setupModuleLoader(window) {
189190
* @ngdoc method
190191
* @name angular.Module#directive
191192
* @methodOf angular.Module
192-
* @param {string} name directive name
193+
* @param {string|Object} name Directive name, or an object map of directives where the
194+
* keys are the names and the values are the factories.
193195
* @param {Function} directiveFactory Factory function for creating new instance of
194196
* directives.
195197
* @description

src/ng/compile.js

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -168,10 +168,11 @@ function $CompileProvider($provide) {
168168
* @description
169169
* Register a new directive with the compiler.
170170
*
171-
* @param {string} name Name of the directive in camel-case. (ie <code>ngBind</code> which will match as
172-
* <code>ng-bind</code>).
173-
* @param {function|Array} directiveFactory An injectable directive factory function. See {@link guide/directive} for more
174-
* info.
171+
* @param {string|Object} name Name of the directive in camel-case (i.e. <code>ngBind</code> which
172+
* will match as <code>ng-bind</code>), or an object map of directives where the keys are the
173+
* names and the values are the factories.
174+
* @param {function|Array} directiveFactory An injectable directive factory function. See
175+
* {@link guide/directive} for more info.
175176
* @returns {ng.$compileProvider} Self for chaining.
176177
*/
177178
this.directive = function registerDirective(name, directiveFactory) {

src/ng/controller.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ function $ControllerProvider() {
1818
* @ngdoc function
1919
* @name ng.$controllerProvider#register
2020
* @methodOf ng.$controllerProvider
21-
* @param {string} name Controller name
21+
* @param {string|Object} name Controller name, or an object map of controllers where the keys are
22+
* the names and the values are the constructors.
2223
* @param {Function|Array} constructor Controller constructor fn (optionally decorated with DI
2324
* annotations in the array notation).
2425
*/

0 commit comments

Comments
 (0)