architecture documentation

architecture documentation

Postby blorby » 05 Jul 2011, 08:27

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.
blorby
 
Posts: 3
Joined: 03 Jul 2011, 13:56

Re: architecture documentation

Postby StefanP.MUC » 05 Jul 2011, 16:15

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.
StefanP.MUC
 

Re: architecture documentation

Postby svenskmand » 06 Jul 2011, 11:53

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.
Jamendo.com - The best music store on the net, uses CC licenses.
User avatar
svenskmand
OD Moderator
 
Posts: 1850
Joined: 09 Dec 2009, 00:07
Location: Denmark

Re: architecture documentation

Postby oln » 06 Jul 2011, 17:19

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.
User avatar
oln
 
Posts: 1020
Joined: 26 Oct 2010, 22:16
Location: Norway

Who is online

Users browsing this forum: No registered users and 0 guests