design directory, ERM; was: Doxygen - is there a status?

Frank H. Ellenberger frank.h.ellenberger at gmail.com
Thu Sep 4 12:04:34 EDT 2014


Am 04.09.2014 um 16:26 schrieb John Ralls:
> Just like Carsten you missed the point that the *design*
> documentation doesn't and can't live in the code files and isn't part
> of writing a patch.

Just for completeness:
There is a bunch of texi files in src/doc/design.
 - But https://github.com/Gnucash/gnucash/commits/master/src/doc/design
shows only sparse updates after 2001.
 - And Intro starts with "This whole document is completely outdated.
Don't read this. All function names and every described structure has
changed completely. Only read this if you want to know how gnucash
looked like in 1999. This is completely outdated!"

So, I agree, mediawiki texts are today easier to maintain than texinfo
files. Perhaps we should replace the content of this directory with a
file containing pointers to the respective wiki pages.

But we should add somewhere in the doxygen linked readme files
 - A sketch of the modules, their purpose and relations
 - Explanation of namespaces gnc_, qof_, xacc_, ...

BTW:
Am 03.09.2014 um 10:57 schrieb Carsten Rinke:
> BTW: I took a look at the Wiki C API page. There is also good stuff
> in it. Note that the link to the entity relationship diagram returns
> 404 and offers me a log in. Is that correct?
John, didn't you update the ERM some time ago? But later it became
inaccessible.

Regards
Frank


More information about the gnucash-devel mailing list