allow for arbitrary tags + tests

tj · Dec 9, 2011 · 42a3fcb · 42a3fcb
1 parent ca0a890
commit 42a3fcb
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 1 deletion.
diff --git a/lib/dox.js b/lib/dox.js
@@ -158,6 +158,9 @@ exports.parseTag = function(str) {
     case 'type':
       tag.types = exports.parseTagTypes(parts.shift());
       break;
+    default:
+      tag.string = parts.join(' ');
+      break;
   }
 
   return tag;

diff --git a/test/dox.test.js b/test/dox.test.js
@@ -123,7 +123,7 @@ module.exports = {
     fixture('d.js', function(err, str){
       var comments = dox.parseComments(str);
       var first = comments.shift();
-      first.tags.should.have.length(3);
+      first.tags.should.have.length(4);
       first.description.full.should.equal('<p>Parse tag type string "{Array|Object}" etc.</p>');
       first.description.summary.should.equal('<p>Parse tag type string "{Array|Object}" etc.</p>');
       first.description.body.should.equal('');
@@ -242,5 +242,11 @@ module.exports = {
     tag.type.should.equal('return');
     tag.types.should.eql(['String']);
     tag.description.should.equal('a normal string');
+  },
+
+  'test .parseTag() default': function(){
+    var tag = dox.parseTag('@hello universe is better than world');
+    tag.type.should.equal('hello');
+    tag.string.should.equal('universe is better than world');
   }
 };
diff --git a/test/fixtures/d.js b/test/fixtures/d.js
@@ -2,6 +2,7 @@
 /**
  * Parse tag type string "{Array|Object}" etc.
  *
+ * @name is arbitrary
  * @param {String} str
  * @return {Array}
  * @api public