open-wc/custom-elements-manifest

Descriptions when using the `@readonly` JSDoc tag

break-stuff opened this issue · 1 comments

break-stuff commented

Checklist

  • Did you run the analyzer with the --dev flag to get more information?
  • Did you create a minimal reproduction in the playground?

Completing the items above will greatly improve triaging time of your issue.

The order of the @readonly jsDoc tag determines if the description is captured.

This does not work:

/** @readonly My description */

Neither does this:

/** 
  * @readonly 
  * My description 
  */

But this does work:

/** 
  * My description 
  * @readonly 
  */

Expected behavior
A clear and concise description of what you expected to happen.

I would expect the description to be captured in each of these scenarios.

thepassle commented

Can you create a PR? 🙂