clean-jsdoc-theme icon indicating copy to clipboard operation
clean-jsdoc-theme copied to clipboard

Summary tag doesn't add class to the correct html element

Open VanWeapon opened this issue 3 years ago • 2 comments

Describe the bug

When adding a jsdoc @summary tag, the generated html looks like so:

<p class="summary"></p>
<p>Actual summary content text</p>
<p></p>
... rest of document

The summary class is attached to an empty paragraph tag and the docs content is added to an unstyled p tag.

To Reproduce

Steps to reproduce the behavior:

  1. Add an @summary tag to any class method documentation
  2. observe the output html when inspected

Expected behavior

The html class "summary" should be on a div which wraps the <p> tag containing the summary text. This is so that we can target the summary class element accurately for adding styles to it with css or js

Desktop (please complete the following information):

  • OS: windows
  • Browser: all
  • Version latest

VanWeapon avatar Aug 28 '22 01:08 VanWeapon

Wonderful, you have created your first issue for clean-jsdoc-theme. Someone will talk to you soon!

github-actions[bot] avatar Aug 28 '22 01:08 github-actions[bot]

Thanks for reporting this. I will look into it.

ankitskvmdam avatar Aug 29 '22 09:08 ankitskvmdam