Documentation for Polymer 2.0 elements

[nikolay...@teamdev.com]

I suppose that <iron-component-page> is not available for Polymer 2.0 elements, so is there any solution for class-based elements documentation?

[Arthur Evans]

Hi Nikolay,

2.x will support API docs much like 1.x, with the exception that the team isn't planning to support on-the-fly analysis like iron-component-page does in 1.x, which was slow and problematic (although very convenient).

For 2.x, you'll need a build step to run polymer-analyzer on your elements and dump a JSON file that can be read by iron-doc-viewer. We may also end up adding some functionality into the CLI (for example, polymer serve could auto-generate docs). 

Unfortunately, this isn't packaged up into a convenient end-user tool yet. You can see Node script we use to generate the core API docs here: https://github.com/Polymer/docs/blob/master/scripts/generate_api_docs_2.js

There are some new doc annotations for 2.x. You can see them in use in the core library: https://github.com/Polymer/polymer/pull/4568/files

I don't think doc tooling is going to be ready to ship with 2.x, but hopefully we'll be able to supply some tools and docs in the near future. Until then, hope this helps.

Thanks,

Arthur

On Sat, May 6, 2017 at 2:21 AM, <nikolay...@teamdev.com> wrote:

I suppose that <iron-component-page> is not available for Polymer 2.0 elements, so is there any solution for class-based elements documentation?

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 polymer-dev+unsubscribe@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/polymer-dev/f83eae51-9daa-4bfc-9067-624a1a7f91c4%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[nikolay...@teamdev.com]

Hi Arthur,

It should help, thanks.