PlantUML

[Antonio Fornié Casarrubios <an...@gmail.com>]

Hi all,

In order to make it easier for developers to understand better cloudstack
and its code, I think sometimes an UML diagram could help a lot. IMO much
more than comments and headers most times. My favorite tool for UML is
PlantUML mainly because it's plain text that can be viewed with a Plant
plugin (or any other PlantUML flavour). So if a diagram gets obsolete it's
easy and fast to update the PlantUML file, commit it and everybody will see
the diagram updated. that way we don't commit images or strange formats,
just text. And if considered necessary any of these diagrams can also be
exported (for example with the same PlantUML eclipse plugin).

If you guys agree, I would then proceed and commit my first PlantUML files.
By the way, in such case I would also like confirmation o where to place
them for each module.

http://plantuml.sourceforge.net/

Thanks and cheers
Antonio Fornie
Schuberg Philis - MCE

Re: PlantUML

[Daan Hoogland <da...@gmail.com>]

I discussed with Antonio internally; we are in diagreement.

I would like to see some kind of context diagram inside java class javadocs.
Antonio would go for a seperate file (on package level, Antonio?)

any others have brain waves on this?

On Thu, Feb 6, 2014 at 2:03 PM, Antonio Fornié Casarrubios
<an...@gmail.com> wrote:
> Hi all,
>
> In order to make it easier for developers to understand better cloudstack
> and its code, I think sometimes an UML diagram could help a lot. IMO much
> more than comments and headers most times. My favorite tool for UML is
> PlantUML mainly because it's plain text that can be viewed with a Plant
> plugin (or any other PlantUML flavour). So if a diagram gets obsolete it's
> easy and fast to update the PlantUML file, commit it and everybody will see
> the diagram updated. that way we don't commit images or strange formats,
> just text. And if considered necessary any of these diagrams can also be
> exported (for example with the same PlantUML eclipse plugin).
>
> If you guys agree, I would then proceed and commit my first PlantUML files.
> By the way, in such case I would also like confirmation o where to place
> them for each module.
>
> http://plantuml.sourceforge.net/
>
> Thanks and cheers
> Antonio Fornie
> Schuberg Philis - MCE



-- 
Daan