Hi Eric, I wonder if this sort of automatic documentation is only made for polymer core (and ui) components, or if that should also be the way to go when implementing custom polymer elements.
Over at AngularJS, we've built a new tool to make automation of documentation generation called "dgeni". Basically the tool itself is nothing more than a system that consumes a stack of processors and pipes them at execution time. This gives us super high flexibility when it comes to custom features like custom annotations, custom templates, filters, actually what ever you want. It's still in early development but is already used for the angular docs. Now I thought it'd probably also a cool thing to build a processor package for it that handles polymer specific features. Other people that develop polymer components could use the same features too then. On Monday, April 8, 2013 9:02:19 PM UTC+2, Eric Bidelman wrote: > > Inspired by Mike K's great idea of self documenting custom elements, I've > written a proposal to formalize the effort. > We have a great opportunity here to come up with best practices early on. > > *Proposal: Self Documenting Custom Elements <http://goo.gl/X5DxO>* > - prototype <http://goo.gl/0pdSW> - a custom element that uses this > method. > - it's <wc-documentation> <http://goo.gl/qzW7P> (best viewed in > Chrome Canary to get ::distributed()). > > [image: Inline image 1] > > Things I like about this approach: > > - The delivery mechanism is <link rel="import">. > - Becomes the "view source of custom elements". Click an import's link -> > get its docs. > - The docs themselves are custom elements > - works reasonably well in other modern browsers, especially if the > toolkit polyfills are included. > > Looking for everyone's feedback. > > Eric Bidelman > Follow Polymer on Google+: plus.google.com/107187849809354688692 --- You received this message because you are subscribed to the Google Groups "Polymer" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To view this discussion on the web visit https://groups.google.com/d/msgid/polymer-dev/f4d4b3d2-d9d3-41e8-a015-065851cc3bab%40googlegroups.com. For more options, visit https://groups.google.com/d/optout.
