> And Akonadi is, of course, a great idea.  The only real issue is
> trying to remove the file dependence from Basket as a whole.  I've
> taken on a project some time last year to try to rip all of it out,
> and boy, is it messy.
> 
> The whole code base is quite a mess, so adding new, adventurous things
> such as a QGraphicsView canvas and Akonadi support is tough because of
> that.

True.  As a step toward cleaning things up, it occurred to me it would be 
useful to go through the code class by class and document (using doxygen) each 
function and class.  I've begun doing this several times in a row only to 
start over each time because I realized that I'd missed something critical in 
the initial set up of Doxygen.  

It will take me some time, but I still plan to do this.  I will create a new 
"documentation" branch off of my gitorious repository as soon as I have things 
in place.  Anyone who wants to contribute is more than welcome to help me hack 
this stuff out.  Doxygen itself helps you keep track of which functions are 
still undocumented.

If I beg and plead with my wife, she might be willing to make a nice 
stylesheet for it so that we can have nice, pretty (and easy to use) 
documentation like the Qt API.

Not only will this (hopefully) bring new developers on board, it will make it 
easier to find dependencies within the code.  This, in turn, will make it 
easier to restructure things.

I think part of the problem is that we've lost "code memory".  Since Sebastien 
isn't actively developing basKet, it is sometimes hard to figure out what some 
of the code does or why.  Documenting the different parts could help a lot.

Robert

Attachment: signature.asc
Description: This is a digitally signed message part.

------------------------------------------------------------------------------
Throughout its 18-year history, RSA Conference consistently attracts the
world's best and brightest in the field, creating opportunities for Conference
attendees to learn about information security's most important issues through
interactions with peers, luminaries and emerging and established companies.
http://p.sf.net/sfu/rsaconf-dev2dev
_______________________________________________
Basket-devel mailing list
Basket-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/basket-devel

Reply via email to