search

orchidhq / Orchid

Build and deploy beautiful documentation sites that grow with you
https://orchid.run
GNU General Public License v3.0
514 stars 53 forks source link

Generate and embed PlantUML diagrams into Orchid Kdoc #275

Open DanySK opened 5 years ago

DanySK commented 5 years ago

This is a feature proposal for improving the Kdoc documentation tool (and, possibly, other documentation tools). Using the information currently used for generating the pages, we could generate and embed an UML class diagram with:

The apiviz doclet for Javadoc can do something similar.

cjbrooks12 commented 5 years ago

@javaherisaber was asking about something similar in the Gitter chat. I haven't seen the APIViz doclet before, but it looks like it should be able to be done easily enough in Orchid.

The only potential concern from me is that it adds a dependency between the OrchidKotlindoc and OrchidDiagrams plugins, which I'm trying to avoid. I feel like this should be broken out into a separate plugin. Modularizing the code-doc structure (which I want to break ground on very soon with #232) will make this less of a concern, but it will be a little while until I could add this feature to Orchid itself.

In the meantime, you could try making your Component which adds this functionality, if you're looking for something more immediate. I'd be happy to help you get that setup and figure out how these pieces would all fit together in a custom Component so you could flesh it out.

Odaym commented 5 years ago

I would like to have this feature mainly to be able to onboard new developers more easily by showing them an overview of the classes and how they work together, for the bigger picture of what's going on really. Thanks a lot for the effort