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

@type description after dot is ignored/removed in docs #569

Open
1 of 5 tasks
bencresty opened this issue Apr 3, 2021 · 0 comments
Open
1 of 5 tasks

@type description after dot is ignored/removed in docs #569

bencresty opened this issue Apr 3, 2021 · 0 comments

Comments

@bencresty
Copy link

bencresty commented Apr 3, 2021

Make sure these boxes are checked before submitting your issue - thank you!
(If your issue is neither a both bug nor a request, please write in a free style)

Short summary of your issue

When having a dot in a description of a @type everything behind it doesn't make it to the docs.

Example:

When having this:

/**
 * Resize mode. Must be either 'contain' or 'cover'
 * @type {string}
 */
this.resizeMode = undefined;

It results like this in the docs, so is missing crucial information (the line "Must be either 'contain' or 'cover'" is missing):
image

[edit]
Using @desc has the same issue, so this:

/**
 * @desc Resize mode. Must be either `'contain'` or `'cover'`
 * @type {string}
 */
this.resizeMode = undefined;

...is also missing the same line in the docs.

Input data for reproducing

see above

Codes

see above

Output data

see above

Screen shot of documentation

see above

Exception output (if possible)

no exception

Your environment

  • OS type and version: windows 10
  • Node.js version: 14.15.3
  • ESDoc version: 1.1.0
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

1 participant