Page 1 of 1

architecture documentation

PostPosted: 05 Jul 2011, 08:27
by blorby
I've been wondering..
Is there any architecture documentation available with some basics UML or block diagrams explaining the interactions between internal and external components ?
That would be helpful for about every dev to know where they put they hands in.

Re: architecture documentation

PostPosted: 05 Jul 2011, 16:15
by StefanP.MUC
The code is in wide parts doxygen commented. So, there's the possibility to download doxygen and let it analyse the code for you.

We don't have a general public overview or vizualisation of the code. But this is something we should really do.

Problem currently is: We are in a state of heavy refactorings and "standardizations" and removing/adding files, classes, features (especially the "roots" as in core FrameListener, input system and GameState control is currently under heavy changings). So, directly working on these wouldn't be the best way to start codng on OD, anyways.

After the code is in a "normalized" state and all base classes are defined, we will definitly create some flow charts and put it on the wiki.

Re: architecture documentation

PostPosted: 06 Jul 2011, 11:53
by svenskmand
blorby {l Wrote}:I've been wondering..
Is there any architecture documentation available with some basics UML or block diagrams explaining the interactions between internal and external components ?
That would be helpful for about every dev to know where they put they hands in.

I do not think we have any of that :S. But we are going to use a new thread model, and I have made diagrams for that. But since it is not implemented it is not very helpful.

But it would be a nice think to have, and we could add it as a todo on the bugtracker. Maybe you would like to start making the documentation as you get into the code? But of course first after the code is in a more stable state.

Re: architecture documentation

PostPosted: 06 Jul 2011, 17:19
by oln
svenskmand {l Wrote}:
blorby {l Wrote}:I've been wondering..
Is there any architecture documentation available with some basics UML or block diagrams explaining the interactions between internal and external components ?
That would be helpful for about every dev to know where they put they hands in.

That thread also contains the current thread model.
There is a diagram that andrew made as well somewhere on the wiki.