Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Malformed HTML when parsing 'default' JSDoc tags #48

Closed
rdipardo opened this issue Nov 12, 2020 · 1 comment
Closed

Malformed HTML when parsing 'default' JSDoc tags #48

rdipardo opened this issue Nov 12, 2020 · 1 comment

Comments

@rdipardo
Copy link
Contributor

Describe the bug

When a member has a @default or @defaultvalue tag, the closing div of the HTML description is malformed (specifically, it looks like this: </div)

To Reproduce

  1. Clone my fork
  2. Run npm i && npm run doc:issue
  3. Open the generated @default-tag-issue/doc/CSS.html file in vim (or some other editor)
  4. Using vim, enter :g/.<\/div$, or type .<\/div$ into your editor's search box with regular expressions activated
  5. There will be 4 matches, around lines 146, 220, 294, 368 (see screenshots below)

Expected behavior

@default metadata should render as valid HTML.

For now, the problem can be fixed by removing all @default and @defaultvalue tags from the JSDoc markup; users should be advised not to use these tags until the bug is patched.

Screenshots

Using the @default tag . . .

Screenshot_2020-11-12_01-35-42

. . . produces HTML like this:

malformed_div_1

. . . in every place where the @default tag is encountered:

malformed_div_2

malformed_div_3

. . . which breaks the layout:

Screenshot_2020-11-12_01-36-44

Desktop

  • OS: Debian Buster 10.5
  • Browser Firefox
  • Version 82.0.3
  • clean-jsdoc-theme version 2.2.13

Additional context

  • it behaves the same with the @defaultvalue alternative tag as with @default
  • same results using the light or dark theme
@ankitskvmdam
Copy link
Owner

Thanks for reporting. I have fix the bug and also publish it on npm (clean-jsdoc-theme^2.2.14).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants