docs(angular.Module): fix controller and directive method parameters

This commit is contained in:
David Bennett 2013-09-23 21:45:48 -04:00 committed by Brian Ford
parent e5eeb2e825
commit 5bb9ba2c54
3 changed files with 11 additions and 7 deletions

View file

@ -216,7 +216,8 @@ function setupModuleLoader(window) {
* @ngdoc method * @ngdoc method
* @name angular.Module#controller * @name angular.Module#controller
* @methodOf angular.Module * @methodOf angular.Module
* @param {string} name Controller name. * @param {string|Object} name Controller name, or an object map of controllers where the
* keys are the names and the values are the constructors.
* @param {Function} constructor Controller constructor function. * @param {Function} constructor Controller constructor function.
* @description * @description
* See {@link ng.$controllerProvider#register $controllerProvider.register()}. * See {@link ng.$controllerProvider#register $controllerProvider.register()}.
@ -227,7 +228,8 @@ function setupModuleLoader(window) {
* @ngdoc method * @ngdoc method
* @name angular.Module#directive * @name angular.Module#directive
* @methodOf angular.Module * @methodOf angular.Module
* @param {string} name directive name * @param {string|Object} name Directive name, or an object map of directives where the
* keys are the names and the values are the factories.
* @param {Function} directiveFactory Factory function for creating new instance of * @param {Function} directiveFactory Factory function for creating new instance of
* directives. * directives.
* @description * @description

View file

@ -170,10 +170,11 @@ function $CompileProvider($provide) {
* @description * @description
* Register a new directive with the compiler. * Register a new directive with the compiler.
* *
* @param {string} name Name of the directive in camel-case. (ie <code>ngBind</code> which will match as * @param {string|Object} name Name of the directive in camel-case (i.e. <code>ngBind</code> which
* <code>ng-bind</code>). * will match as <code>ng-bind</code>), or an object map of directives where the keys are the
* @param {function|Array} directiveFactory An injectable directive factory function. See {@link guide/directive} for more * names and the values are the factories.
* info. * @param {function|Array} directiveFactory An injectable directive factory function. See
* {@link guide/directive} for more info.
* @returns {ng.$compileProvider} Self for chaining. * @returns {ng.$compileProvider} Self for chaining.
*/ */
this.directive = function registerDirective(name, directiveFactory) { this.directive = function registerDirective(name, directiveFactory) {

View file

@ -19,7 +19,8 @@ function $ControllerProvider() {
* @ngdoc function * @ngdoc function
* @name ng.$controllerProvider#register * @name ng.$controllerProvider#register
* @methodOf ng.$controllerProvider * @methodOf ng.$controllerProvider
* @param {string} name Controller name * @param {string|Object} name Controller name, or an object map of controllers where the keys are
* the names and the values are the constructors.
* @param {Function|Array} constructor Controller constructor fn (optionally decorated with DI * @param {Function|Array} constructor Controller constructor fn (optionally decorated with DI
* annotations in the array notation). * annotations in the array notation).
*/ */