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

Export jsdoc related things #171

Closed fdesforges closed 4 years ago

fdesforges commented 4 years ago

fix runem/web-component-analyzer#170

runem commented 4 years ago

Thanks for the contribution. Normally I'm a bit hesitant to expose util functions, but I see how JSDoc utils are really important when building custom flavors. I still consider external custom flavors as an area where I can improve the API/documentation, so the API might end up changing a bit around custom flavors. However, I'll keep in mind that JSDoc utils should be available :+1:

fdesforges commented 4 years ago

Thanks !

If you want i can document it with some examples.

runem commented 4 years ago

Thanks for offering your help! :-) Right now I still have some small changes that I want to make to the plugin API before documenting and making it "official". If you have some input on what you would like to see in the plugin API feel free to add your comments here or make an issue with your suggestion :sunny: