Skip to content

@internal JSDoc tag doesn't exclude methods from deno doc #29020

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

Open
dandv opened this issue Apr 23, 2025 · 1 comment
Open

@internal JSDoc tag doesn't exclude methods from deno doc #29020

dandv opened this issue Apr 23, 2025 · 1 comment

Comments

@dandv
Copy link
Contributor

dandv commented Apr 23, 2025

I'm trying to exclude from deno doc internal methods that must be public, such as [Symbol.dispose](). The @internal JSDoc tag doesn't prevent deno doc from including the tagged symbols in its output. Simply not documenting the method results in the deno doc linter complaining exported symbol is missing JSDoc documentation.

Repro JSR doc page: https://jsr.io/@dandv/timestamp-logger/doc/~/Logger#method_symbol_asyncdispose_0

Source code: mod.ts

private symbols are also included in the documentation output, but fortunately # private class fields are excluded.

Version: Deno 2.2.11

@nberlette
Copy link
Contributor

Related: denoland/deno_doc#590

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

2 participants