feat: Add support for yields tag (#3)

Author: devongovett

lib/doctrine.js

@@ -53,6 +53,10 @@
         return title === 'return' || title === 'returns';
     }
 
+    function isYieldsTitle(title) {
+        return title === 'yield' || title === 'yields';
+    }
+
     function isProperty(title) {
         return title === 'property' || title === 'prop';
     }
@@ -75,7 +79,7 @@
     }
 
     function isTypeParameterRequired(title) {
-        return isParamTitle(title) || isReturnTitle(title) ||
+        return isParamTitle(title) || isReturnTitle(title) || isYieldsTitle(title) ||
             title === 'define' || title === 'enum' ||
             title === 'implements' || title === 'this' ||
             title === 'type' || title === 'typedef' || isProperty(title);
@@ -450,7 +454,7 @@
                 try {
                     this._tag.type = parseType(this._title, this._last, this._options.range);
                     if (!this._tag.type) {
-                        if (!isParamTitle(this._title) && !isReturnTitle(this._title)) {
+                        if (!isParamTitle(this._title) && !isReturnTitle(this._title) && !isYieldsTitle(this._title)) {
                             if (!this.addError('Missing or invalid tag type')) {
                                 return false;
                             }

test/parse.js

@@ -1383,6 +1383,23 @@ describe('parse', function () {
         e1.fields.should.containEql({type: 'FieldType', key: 'error',
           value: {type: 'NameExpression', name: 'Error'}});
     });
+
+    it('yields', function () {
+        var res = doctrine.parse(
+            [
+                "/**",
+                " * @yields {String} userName",
+                "*/"
+            ].join('\n'), { unwrap: true });
+        res.tags.should.have.length(1);
+        res.tags[0].should.have.property('title', 'yields');
+        res.tags[0].should.have.property('description', 'userName');
+        res.tags[0].should.have.property('type');
+        res.tags[0].type.should.eql({
+            type: 'NameExpression',
+            name: 'String'
+        });
+    });
 });
 
 describe('parseType', function () {