Update Rule: inlined tags in requireDescriptionCompleteSentence

Fixes #180
Closes gh-181

Author: qfox

lib/rules/validate-jsdoc/require-description-complete-sentence.js

@@ -11,9 +11,9 @@ module.exports.options = {
  * does not start with an upper case letter.
  * It also matches a period not fllowed by an upper case letter.
  */
-var RE_NEW_LINE_START_WITH_UPPER_CASE = /[*]*((\n[*\s]*\n)|[.])[*\s]*[a-z]/g;
+var RE_NEW_LINE_START_WITH_UPPER_CASE = /((\n\s*\n)|\.)\s*[a-z]/g;
 
-var START_DESCRIPTION = /^[*\s]*[a-z]/g;
+var START_DESCRIPTION = /^\s*[a-z]/g;
 
 var RE_END_DESCRIPTION = /\n/g;
 
@@ -24,7 +24,7 @@ var RE_END_DESCRIPTION = /\n/g;
  * upper case letter where the previous line does not have a period
  * Note that numbers count as word characters.
  */
-var RE_NEW_LINE_UPPERCASE = /\w(?![.])(\W)*\n\W*[A-Z]/g;
+var RE_NEW_LINE_UPPERCASE = /\w(?!\.)(\W)*\n\W*[A-Z]/g;
 
 /**
  * Checks that a sentence followed by a blank line has a period
@@ -34,7 +34,7 @@ var RE_NEW_LINE_UPPERCASE = /\w(?![.])(\W)*\n\W*[A-Z]/g;
  *
  * This also matches white-space followed by a period.
  */
-var RE_END_WITH_PERIOD = /(\s\.|[^\s\.])(?!\.)(\n|$)[*\s]*(\n|$)/g;
+var RE_END_WITH_PERIOD = /(\s\.|[^\s\.])(?!\.)(\n|$)\s*(\n|$)/g;
 
 /**
  * Requires description to be a complete sentence in a jsdoc comment.
@@ -47,44 +47,47 @@ var RE_END_WITH_PERIOD = /(\s\.|[^\s\.])(?!\.)(\n|$)[*\s]*(\n|$)/g;
  */
 function requireDescriptionCompleteSentence(node, err) {
     var doc = node.jsdoc;
-    if (!doc || !doc.tags.length || !doc.description || !doc.description.length) {
+    if (!doc || !doc.description || !doc.description.length) {
         return;
     }
 
     var loc = doc.loc.start;
-    var lines = doc.description.split(RE_END_DESCRIPTION);
+    var sanitized = doc.description.replace(/\{([^}]+)\}/, function(_, m) {
+        return '{' + (new Array(m.length + 1)).join('*') + '}';
+    });
+    var lines = sanitized.split(RE_END_DESCRIPTION);
 
     var errors = [];
 
-    if (START_DESCRIPTION.test(doc.description)) {
-        var matches = returnAllMatches(doc.description, START_DESCRIPTION);
+    if (START_DESCRIPTION.test(sanitized)) {
+        var matches = returnAllMatches(sanitized, START_DESCRIPTION);
         matches.map(function(match) {
             match.message = 'Description must start with an upper case letter';
             match.index = match.start;
         });
         errors = errors.concat(matches);
     }
 
-    if (RE_NEW_LINE_START_WITH_UPPER_CASE.test(doc.description)) {
-        var matches1 = returnAllMatches(doc.description, RE_NEW_LINE_START_WITH_UPPER_CASE);
+    if (RE_NEW_LINE_START_WITH_UPPER_CASE.test(sanitized)) {
+        var matches1 = returnAllMatches(sanitized, RE_NEW_LINE_START_WITH_UPPER_CASE);
         matches1.map(function(match) {
             match.message = 'Sentence must start with an upper case letter';
             match.index = match.end - 1;
         });
         errors = errors.concat(matches1);
     }
 
-    if (RE_END_WITH_PERIOD.test(doc.description)) {
-        var matches2 = returnAllMatches(doc.description, RE_END_WITH_PERIOD);
+    if (RE_END_WITH_PERIOD.test(sanitized)) {
+        var matches2 = returnAllMatches(sanitized, RE_END_WITH_PERIOD);
         matches2.map(function(match) {
             match.message = 'Sentence must end with a period';
             match.index = match.start;
         });
         errors = errors.concat(matches2);
     }
 
-    if (RE_NEW_LINE_UPPERCASE.test(doc.description)) {
-        var matches3 = returnAllMatches(doc.description, RE_NEW_LINE_UPPERCASE);
+    if (RE_NEW_LINE_UPPERCASE.test(sanitized)) {
+        var matches3 = returnAllMatches(sanitized, RE_NEW_LINE_UPPERCASE);
         matches3.map(function(match) {
             match.message = 'You started a new line with an upper case letter but ' +
                 'previous line does not end with a period';

test/lib/rules/validate-jsdoc/require-description-complete-sentence.js

@@ -166,6 +166,17 @@ describe('lib/rules/validate-jsdoc/require-description-complete-sentence', funct
                      */
                     function fun(p) {}
                 }
+            }, {
+                it: 'should not report inlined tags #180',
+                code: function () {
+                    /**
+                     * Heading.
+                     *
+                     * This method uses the algorithm defined here:
+                     * {@link http://stackoverflow.com/questions/1073336/circle-line-segment-collision-detection-algorithm}
+                     */
+                    function fun(p) {}
+                }
             }
             /* jshint ignore:end */
         ]);