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

License headers should not show up on module-level docs #550

Open
roj1512 opened this issue Apr 19, 2024 · 7 comments
Open

License headers should not show up on module-level docs #550

roj1512 opened this issue Apr 19, 2024 · 7 comments

Comments

@roj1512
Copy link
Contributor

roj1512 commented Apr 19, 2024

No description provided.

@iuioiua
Copy link
Contributor

iuioiua commented Apr 21, 2024

Please elaborate and provide an example of where you're seeing this.

@roj1512
Copy link
Contributor Author

roj1512 commented Apr 22, 2024

@roj1512
Copy link
Contributor Author

roj1512 commented Apr 22, 2024

No symbol has this doc.

image

@iuioiua
Copy link
Contributor

iuioiua commented Apr 24, 2024

This behaviour is expected. deno_doc sees this text as a plain JSDoc description. Currently, the way to do this is to prefix each line of the comment with // instead of wrapping it in /** ... */. Either way, supporting the @license JSDoc tag would be nice if someone wants to display their license.

@roj1512
Copy link
Contributor Author

roj1512 commented Apr 24, 2024

Did I understand this wrongly or this module-level doc used to be explicitly enabled with @module?

@iuioiua
Copy link
Contributor

iuioiua commented Apr 26, 2024

Yes, I believe the @module tag is required to denote module-level docs. But do not confuse what you shared (https://jsr.io/@mtkruto/mtkruto/doc/~/MtkrutoError) as a module doc. It's a symbol doc for the MtkrutoError class.

@roj1512
Copy link
Contributor Author

roj1512 commented Apr 26, 2024

Oh, I just understood.

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