Merge pull request #62 from straker/typeMarkdown

feat(tags): tag with only a type of markdown parsed as string instead of object

Author: straker

lib/parseComments.js

@@ -85,24 +85,27 @@ function parseComments(data, file, tags, context, callback) {
 
         // if the tag has no description assume it's a boolean flag and default to
         // true
-        if (!tag.name && !tag.type) {
-          entry = tag.description || true;
+        var description = tag.description || true;
+
+        // parse any tag of type {marked} as mark down
+        if (tag.type === 'markdown') {
+          description = marked(description).replace(trimNewlineRegex, '');
+        }
+
+        // leave markdown types as a string
+        if (!tag.name && (!tag.type || tag.type === 'markdown')) {
+          entry = description;
         }
         else {
           entry = {
-            description: tag.description || true,
+            description: description,
           };
 
           if (tag.name) {
             entry.name = tag.name;
           }
           if (tag.type) {
             entry.type = tag.type;
-
-            // parse any tag of type {marked} as mark down
-            if (tag.type === 'markdown') {
-              entry.description = marked(entry.description).replace(trimNewlineRegex, '');
-            }
           }
         }
 

lib/tags.js

@@ -37,7 +37,7 @@ var tags = {
   section: function () {
     var name, description;
 
-    //added trim() to normalize returns on different OSs    
+    //added trim() to normalize returns on different OSs
     if (!this.tag.description && !this.comment.description.trim() ) {
       throw new SyntaxError('unnamed section (' + this.file + ':' +
         (this.tag.line+1) + ')');
@@ -47,7 +47,7 @@ var tags = {
     // description as the section name and use the rest as the section description
     if (!this.tag.description) {
       var normDescription = normalizeNewline(this.comment.description);
-      name = normDescription.match(firstLineRegex)[1].trimRight();
+      name = normDescription.match(firstLineRegex)[1].trim();
       description = normDescription.substr(name.length + 1);
     }