aboutsummaryrefslogtreecommitdiffstats
path: root/docs/src/ngdoc.js
diff options
context:
space:
mode:
authorMisko Hevery2012-05-16 22:20:35 -0700
committerMisko Hevery2012-05-24 13:48:42 -0700
commitbbaf9a287022a9aa6675e4aab9894fe5bd041ad7 (patch)
treee9fb5f8a63f0879be0cb976b1fcb5cad46f99f05 /docs/src/ngdoc.js
parent7e70463da129dc7a668f234403bc530f562b9999 (diff)
downloadangular.js-bbaf9a287022a9aa6675e4aab9894fe5bd041ad7.tar.bz2
fix(docs): accept return in addition to returns
documentation used @return but parser expected @returns, which made the generated documentation incomplete.
Diffstat (limited to 'docs/src/ngdoc.js')
-rw-r--r--docs/src/ngdoc.js4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/src/ngdoc.js b/docs/src/ngdoc.js
index def665fa..6576e619 100644
--- a/docs/src/ngdoc.js
+++ b/docs/src/ngdoc.js
@@ -227,10 +227,10 @@ Doc.prototype = {
'default':match[6]
};
self.param.push(param);
- } else if (atName == 'returns') {
+ } else if (atName == 'returns' || atName == 'return') {
match = text.match(/^\{([^}=]+)\}\s+(.*)/);
if (!match) {
- throw new Error("Not a valid 'returns' format: " + text);
+ throw new Error("Not a valid 'returns' format: " + text + ' in ' + self.file + ':' + self.line);
}
self.returns = {
type: match[1],