denoland / deno_doc

Documentation generator for Deno
MIT License
254 stars 54 forks source link

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

Open rojvv opened 5 months ago

iuioiua commented 4 months ago

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

rojvv commented 4 months ago

https://jsr.io/@mtkruto/mtkruto/doc/~/MtkrutoError

rojvv commented 4 months ago

No symbol has this doc.

image

iuioiua commented 4 months ago

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.

rojvv commented 4 months ago

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

iuioiua commented 4 months ago

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.

rojvv commented 4 months ago

Oh, I just understood.