jsdoc icon indicating copy to clipboard operation
jsdoc copied to clipboard

Period incorrectly appended to summary (markdown plugin)

Open samwilson opened this issue 6 years ago • 1 comments

When using the markdown plugin, method summaries that do not end in a period get one added after the closing paragraph tag.

Input code

	/**
	 * Get the content wrapper for the current page.
	 *
	 * @return {jQuery} Content wrapper
	 */
	getContentWrapper() {
		return this.$contentWrapper;
	}

	/**
	 * Get the original content of the article
	 *
	 * @return {jQuery} Original content
	 */
	getOriginalContent() {
		return this.$originalContent;
	}

JSDoc configuration

{
  "source": {
    "include": [
      "src/",
      "test/"
    ]
  },
  "opts": {
    "encoding": "utf8",
    "readme": "README.md",
    "tutorials": "tutorials",
    "recurse": true,
    "template": "node_modules/jsdoc-wmf-theme",
    "package": "package.json",
    "destination": "docs"
  },
  "plugins": [
    "plugins/markdown",
    "plugins/summarize"
  ],
  "templates": {
    "cleverLinks": true,
    "default": {
      "useLongnameInNav": true
    },
    "wmf": {
      ...
      }
    }
  }
}

JSDoc debug output

None.

Expected behavior

The period should be added at the end of the sentence.

Current behavior

The period is added on the next line. For the above code example this produces something like the following:

jsdoc

Your environment

Software Version
JSDoc 3.6.3
Node.js 11.5.0
npm 6.9.0
Operating system Linux

samwilson avatar Oct 09 '19 04:10 samwilson

I ran into this as well, and I've got a fix. I'll whip up a testcase for it tomorrow and then i can make a patch.

hartman avatar Aug 23 '23 21:08 hartman