search

Buslowicz / twc

TypeScript based, boilerplate-less, Polymer toolbox friendly Polymer Modules
32 stars 1 forks source link

Preserve documentation #47

Closed tpluscode closed 7 years ago

tpluscode commented 7 years ago

twc should preserve element and property documentation. For elements, Polymer documentation gives two possible ways:

  1. as HTML comment above <dom-module>
  2. if absent, as JS comment before Polymer() call

With twc, there is no <dom-module>, just the template. It may work to always have just the JS comment, even when <dom-module> is used. If not, the comment will have to be moved from JS to HTML

Second, individual properties can be documented. Currently these comments are completely dropped by TypeScript compiler. They will have to be extracted from ts code and moved to the final output

tpluscode commented 7 years ago

It turns out that element-level docs almost work (#58). For this ticket, only property documentation remains. yay!

Buslowicz commented 7 years ago

Element level docs are done, just not merged yet. I am working on property/method docs at this moment and I'm close to finishing :).

Buslowicz commented 7 years ago

Documentation (jsDoc) handling should be fixed now. TWC now handles class-level, property-level and method-level jsDoc.