Merge pull request #167 from pfrankov/master

feat(ngdocs): make description of @param and @returns optional
m7r · Jun 30, 2017 · aa1d76a · aa1d76a
2 parents 580c525 + 699c21d
commit aa1d76a
Showing 1 changed file with 6 additions and 5 deletions.
diff --git a/src/ngdoc.js b/src/ngdoc.js
@@ -413,16 +413,16 @@ Doc.prototype = {
             self.moduleName = match[1];
           }
         } else if (atName == 'param') {
-          match = text.match(/^\{([^}]+)\}\s+(([^\s=]+)|\[(\S+)=([^\]]+)\])\s+(.*)/);
-                             //  1      1    23       3   4   4 5      5  2   6  6
+          match = text.match(/^\{([^}]+)}\s+(([^\s=]+)|\[(\S+)=([^\]]+)])(?:\s+(.*)|$)/);
+                             //  1     1    23       3   4   4 5      5 2      6  6
           if (!match) {
             throw new Error("Not a valid 'param' format: " + text + ' (found in: ' + self.file + ':' + self.line + ')');
           }
 
           var optional = (match[1].slice(-1) === '=');
           var param = {
             name: match[4] || match[3],
-            description:self.markdown(text.replace(match[0], match[6])),
+            description: match[6] ? self.markdown(text.replace(match[0], match[6])) : '',
             type: optional ? match[1].substring(0, match[1].length-1) : match[1],
             optional: optional,
             default: match[5]
@@ -444,13 +444,13 @@ Doc.prototype = {
             self.param.push(param);
           }
         } else if (atName == 'returns' || atName == 'return') {
-          match = text.match(/^\{([^}]+)\}\s+(.*)/);
+          match = text.match(/^\{([^}]+)}(?:\s+(.*)|$)/);
           if (!match) {
             throw new Error("Not a valid 'returns' format: " + text + ' (found in: ' + self.file + ':' + self.line + ')');
           }
           self.returns = {
             type: match[1],
-            description: self.markdown(text.replace(match[0], match[2]))
+            description: match[2] ? self.markdown(text.replace(match[0], match[2])) : ''
           };
         } else if(atName == 'requires') {
           if (/^((({@link).+})|(\[.+\]({@link).+}))$/.test(text)) {
@@ -635,6 +635,7 @@ Doc.prototype = {
 
           dom.html('</td>');
           dom.html('<td>');
+
           dom.html(param.description);
           if (param.default) {
             dom.html(' <p><em>(default: ' + param.default + ')</em></p>');