[OpenLayers-Dev] uml class diagram of OL 2.6?

[Erik Uzureau]

Really it's not such a difficult thing to do, it's more just
repetitive work, which
can be frustrating/tiring.

All I did was go through every .js file and make a new node for every class.
Under each class I listed all the APIMethod/APIFunctions and all the
APIPropertys.

What makes it frustrating is that it is tedious to keep up this sort of a
model.

At the bottom of this page:
http://trac.openlayers.org/wiki/Documentation

you can see a model that cr5 generated automatically from the code.

I can't remember offhand what he used to generate it -- pretty sure it
was something
he wrote himself -- but I think if we are going to put any real effort
into this, we should
be using his tool... at least for what amounts to the data entry part.
Moving around
the nodes so that everything looks nice... that can be done afterwards.

One thing is for sure, though, is that no one should burn any cycles on an
actual model until we put out the 2.7 release... or at least the rc1 thereof.

Chris? What do you say.

erik


On Fri, Aug 29, 2008 at 4:46 PM, Ivan Grcic <ivan.grcic at geofoto.hr> wrote:
> Hi team,
>
> can we discuss little bit about this subject? Because it would be
> really really usefull to have this. If we want to make it possible to
> create UML(or something similar) from code automatically, where should
> we start from? Is there a need to write more thoroughly natural docs
> code, so its easier to make uml then...or should we look for some
> programs like the one mentioned before:
>
> http://www.jsuml.org/
>
> Has anyone tried with this one? It uses Eclipse UML2 model editor...i
> dont have any experience with it. Can someone maybe try to import OL
> to this jsuml?
>
> If nothing is working, i guess we can do it by hand like erik did it here...
> http://openlayers.org/pipermail/dev/2007-April/000581.html
> erik you can tell us what excatlly we have to extract from code, so
> maybe we can split the work...i guess it should be pretty fast to do
> it if thers seeral ppl working on it!
>
> br,
>
> ivan
>
> Anyone tried to
>
> On Thu, Aug 21, 2008 at 6:42 PM, Erik Uzureau <euzuro at gmail.com> wrote:
>> Hi Team,
>>
>> I have added links to
>>
>> http://trac.openlayers.org/wiki/Documentation
>>
>> for the two versions (Emmanuel's and CR5's) of UML diagrams that we
>> have now for the project.
>>
>> If someone is interested in taking it further and doing a full UML
>> diagram of... say... the 2.7 release,
>> it would be welcome... and might even warrant making
>> http://trac.openlayers.org/wiki/UML
>>
>> Cheers,
>> Erik
>>
>> On Fri, Jun 27, 2008 at 12:30 AM, Christopher Schmidt
>> <crschmidt at metacarta.com> wrote:
>>> On Thu, Jun 26, 2008 at 10:07:33PM -0500, Erik Uzureau wrote:
>>>> No plans at this point for a class diagram. Maybe when 3.0 starts
>>>> happenning....
>>>>
>>>> If someone was interested in doing a diagram for 2.6 though I am sure it would
>>>> be helpful for a lot of people
>>>
>>> Not particularly pretty, but:
>>>
>>>  http://crschmidt.net/~crschmidt/ol_graph.png
>>>
>>> Is (mostly) generated by the code in openlayers/tools/oldot.py , fed to
>>> graphviz.
>>>
>>> Needs more work to be 'usable' -- I'm not sure why it doesn't create a
>>> 'more square' graphviz output -- but graphviz has lots of outputs (svg,
>>> dia, pdf, png, jpg, etc. etc.) and does cool things.
>>>
>>> The 'mostly' above is just poor code because it's 1:30AM: there's a
>>> regex that is catching too much, and filenames with "-" in them break
>>> it, but it's pretty close to usable.
>>>
>>> Regards,
>>> --
>>> Christopher Schmidt
>>> MetaCarta
>>>
>>
>