polyforest / acornui-gradle

A bundle of Gradle plugins that helps build Acorn UI projects with ease.
Apache License 2.0
0 stars 0 forks source link

Generate dokka documentation for plugin #27

Open fuzzyweapon opened 5 years ago

fuzzyweapon commented 5 years ago

We will want to use dokka format for our first pass of outputing documentation meant to be consumed via manual browsing of a url.

While javadoc helps make sure that we can publish to MC and will provide IDE completion, dokka will use all of the enriched idiomatic features of dokka to produce what kotlin devs will come to expect.

Ideally we allow devs to also use dokka for their IDE documentation, but it's unclear at this time whether this is possible or how to configure it (good thing to investigate before taking on this task).