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

[api-extractor] @privateRemarks blocks should be removed from .d.ts rollup files #1233

Open
octogonz opened this issue Apr 14, 2019 · 0 comments
Labels
enhancement The issue is asking for a new feature or design change

Comments

@octogonz
Copy link
Collaborator

octogonz commented Apr 14, 2019

Today API Extractor removes the @privateRemarks block from the published documentation; however, it is not removed from the generated .d.ts rollup files. We should improve this, since DocComment.ts says the intended purpose of @privateRemarks is to contain "additional commentary that is not meant for an external audience".

Currently the DtsRollupGenerator class copies the doc comments verbatim into the output. It would be better to use DocComment.emitAsTsdoc() to emit these comments, which would convert them to a normalized form, and also allow us to remove the @privateRemarks blocks.

Before we can do that however, DocComment.emitAsTsdoc() first needs to be improved to support word-wrapping or preserve the original line endings.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement The issue is asking for a new feature or design change
Projects
Status: AE/AD
Development

No branches or pull requests

1 participant