search

Polymer / tools

Polymer Tools Monorepo
BSD 3-Clause "New" or "Revised" License
430 stars 200 forks source link

JSDoc overriding element info #1395

Open rictic opened 9 years ago

rictic commented 9 years ago

Take a look at: https://github.com/PolymerElements/iron-iconset/blob/master/iron-iconset.html

This element has a detailed comment in the HTML, followed by a small jsdoc annotation on the Polymer() call.

Hydrolysis loses the description from the first comment because of the second. Is it reasonable for this not to happen, or should we move the documentation into the script?

arthurevans commented 8 years ago

My understanding was that if you don't have a dom module, docs need to be inside the <script> tag:

https://www.polymer-project.org/1.0/tools/documentation.html#element-summaries

Not saying that this is super-intuitive, but it is the way it's currently documented. @garlicnation can confirm, perhaps?

stale[bot] commented 4 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.