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

Commit a6d7b4b

Browse files
shahatacaitp
authored andcommitted
docs(*): use @description instead of @returns for properties
Dgeni-packages was not actually rendering the `@returns` text. Closes #8639
1 parent 5811c5c commit a6d7b4b

File tree

2 files changed

+7
-4
lines changed

2 files changed

+7
-4
lines changed

src/loader.js

+3-2
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ function setupModuleLoader(window) {
114114
* @ngdoc property
115115
* @name angular.Module#requires
116116
* @module ng
117-
* @returns {Array.<string>} List of module names which must be loaded before this module.
117+
*
118118
* @description
119119
* Holds the list of modules which the injector will load before the current module is
120120
* loaded.
@@ -125,8 +125,9 @@ function setupModuleLoader(window) {
125125
* @ngdoc property
126126
* @name angular.Module#name
127127
* @module ng
128-
* @returns {string} Name of the module.
128+
*
129129
* @description
130+
* Name of the module.
130131
*/
131132
name: name,
132133

src/ng/compile.js

+4-2
Original file line numberDiff line numberDiff line change
@@ -2011,8 +2011,10 @@ function directiveNormalize(name) {
20112011
/**
20122012
* @ngdoc property
20132013
* @name $compile.directive.Attributes#$attr
2014-
* @returns {object} A map of DOM element attribute names to the normalized name. This is
2015-
* needed to do reverse lookup from normalized name back to actual name.
2014+
*
2015+
* @description
2016+
* A map of DOM element attribute names to the normalized name. This is
2017+
* needed to do reverse lookup from normalized name back to actual name.
20162018
*/
20172019

20182020

0 commit comments

Comments
 (0)