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

Feature Request: add capability to suppress documentation #90

Closed
QHGDerek opened this issue Mar 21, 2021 · 1 comment
Closed

Feature Request: add capability to suppress documentation #90

QHGDerek opened this issue Mar 21, 2021 · 1 comment
Labels
request Feature request

Comments

@QHGDerek
Copy link

Example:
https://doc.deno.land/https/deno.land/x/playfab_sdk/support/runtime.ts#SecurityOptions

I have a type called SecurityOptions which is an OR of SecretKey | SessionTicket | EntityToken types. I'm attempting to create a "Oneof" pattern here, where the caller would set 1 of 3 possible keys, but no more than 1. The strategy to do this ends up defining extra fields that I'd like to exclude from my documentation to reduce confusion.

I'd propose some sort of suppression capability in deno_doc. There's prior art in JSDoc to support:
https://jsdoc.app/tags-ignore.html

@bartlomieju bartlomieju added the request Feature request label Aug 24, 2021
@crowlKats
Copy link
Member

Closing as the ignore tag is supported

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

No branches or pull requests

3 participants