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]: Add support for @throws #1632

Merged
merged 4 commits into from
Nov 24, 2019
Merged

Conversation

vidartf
Copy link
Contributor

@vidartf vidartf commented Nov 19, 2019

Fixes #1631.

Note: I originally added a @throws line to one of the interfaces callables, and spent quite some time debugging why this didn't cause any change. I then realized that interface callables are not documented?

@octogonz
Copy link
Collaborator

Note: I originally added a @throws line to one of the interfaces callables, and spent quite some time debugging why this didn't cause any change. I then realized that interface callables are not documented?

Hmmm... you're right. Call signatures are a somewhat obscure feature, so I guess this is a loose end that never got finished. 🤷‍♂ We never use call signatures in the Rush Stack APIs.

I see that call signatures are correctly serialized into the .api.json file, so it should be pretty easy to add a case to MarkdownDocumenter.ts to support them. Since they don't have a name, there might be a design question about how to represent them in the docs (perhaps related to the ae-ambiguous-ids discussion). Probably a pretty easy work item, though. Feel free to open an issue if you need this.

@octogonz octogonz changed the title [api-extractor]/[api-documenter]: Add support for @throws [api-extractor]: Add support for @throws Nov 19, 2019
@octogonz octogonz merged commit 248c0a8 into microsoft:master Nov 24, 2019
@octogonz
Copy link
Collaborator

@vidartf Thanks for contributing this feature! It's been published with API Documenter 7.7.0.

@vidartf vidartf deleted the throws branch November 24, 2019 11:56
rikhoffbauer pushed a commit to rikhoffbauer/microsoft__api-documenter that referenced this pull request Mar 23, 2020
[api-extractor]: Add support for `@throws`
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

Successfully merging this pull request may close these issues.

[api-extractor] Support @throws tag
2 participants