Source code documentation

Question

Hello,

Is there any documentation of the source code? I did my research but couldn't find any.

I would like to add a feature within sequence diagrams for a project, and after a week a reverse-engineering, I still don't understand how a SequenceDiagram object become an image. If some of you have already worked on that, can you explain to me the general process?

Thanks

Answer 1

Not really full developer documentation, but probably a good starting point is to run doxygen (https://www.doxygen.nl/index.html) over the source code, like is done in a general way by Fossies.org (https://fossies.org/) see e.g. https://fossies.org/dox/plantuml-1.2020.13/index.html

Comments

I've found a javadoc (https://javadoc.io/doc/net.sourceforge.plantuml/plantuml/latest/index.html), which is kinda the same as the output of doxygen. As the source code don't have any javadoc written, the javadoc I've found is only a listing of packages and classes with their methods without any explanation of how it works.