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

[doc] TSDoc Error During Build #350

Closed
siyuniu-ms opened this issue Dec 10, 2024 · 1 comment
Closed

[doc] TSDoc Error During Build #350

siyuniu-ms opened this issue Dec 10, 2024 · 1 comment
Assignees
Milestone

Comments

@siyuniu-ms
Copy link

Hi,
I encountered the following TSDoc error when installing this package and running npm run build in my project. Could you please update the comments to resolve these errors?

Thank you!
Warning: node_modules/@nevware21/ts-utils/dist/types/ts-utils.d.ts:492:4 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
Warning: node_modules/@nevware21/ts-utils/dist/types/ts-utils.d.ts:493:4 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
Warning: node_modules/@nevware21/ts-utils/dist/types/ts-utils.d.ts:495:4 - (tsdoc-unsupported-tag) The TSDoc tag "@remarks" is not supported by this tool
Warning: node_modules/@nevware21/ts-utils/dist/types/ts-utils.d.ts:3591:29 - (tsdoc-code-span-missing-delimiter) The code span is missing its closing backtick
Warning: node_modules/@nevware21/ts-utils/dist/types/ts-utils.d.ts:6203:4 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen

@nev21 nev21 self-assigned this Dec 11, 2024
@nev21 nev21 added the investigating Investigating the issue label Dec 11, 2024
@nev21
Copy link
Contributor

nev21 commented Dec 11, 2024

Ok, this is a larger issue than expected as there was no existing tsdoc.json defintion defined and the api-extractor config was ignoring warnings. So this is a larger issue than expected and is taking longer than expected to fix all of the typedoc issues, so it might be another day or two before I have these (ts-utils and ts-async) addressed and released.

One note: the @remarks is expected and you should add this to your tsdoc.json as an expected block comment
include in your supportForTags section of tsdoc.json
"@remarks": true

nev21 added a commit that referenced this issue Dec 12, 2024
nev21 added a commit that referenced this issue Dec 12, 2024
@nev21 nev21 added fixed-waiting-release and removed investigating Investigating the issue labels Dec 13, 2024
@nev21 nev21 added this to the 0.11.6 milestone Dec 13, 2024
@nev21 nev21 closed this as completed Dec 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants