search

runem / web-component-analyzer

CLI that analyzes web components and emits documentation
https://runem.github.io/web-component-analyzer
MIT License
501 stars 63 forks source link

Support original jsdoc event implementation #139

Closed NickdeK closed 4 years ago

NickdeK commented 4 years ago

The official jsdoc implementation requires the event to be defined with class and event type. Using the method described in the readme gives me a warning in IntelliJ editors: Unresolved variable or type 'event:input-switch-check-changed'

So instead of : /* @fires input-switch-check-changed Fires when check property changes */ I need to write the following doc to get rid of the warning: /* @fires InputSwitch#[CustomEvent]input-switch-check-changed Fires when check property changes */

I can understand you still want to support the original example because it's less verbose, but is it possible to also support the original jsdoc event definition?

runem commented 4 years ago

The notation is now supported in version 1.0.3 of WCA, thanks for catching this bug :tada: