Doxygen - is there a status?
jralls at ceridwen.us
Wed Sep 3 10:00:39 EDT 2014
On Sep 3, 2014, at 1:57 AM, Carsten Rinke <carsten.rinke at gmx.de> wrote:
> Hi all,
> thanks for the quick reply.
> I have plenty.
> Big ones like "how does qof work?" and small ones like "what does xacc actually stand for?".
> Geert's hint in one of the bugzilla replies to maybe consider listening to signals in an area that appears to me totally unrelated made me aware that I still do not know GnuCash at all.
> By accident I found the project.html file which is also quite an eye opener, too.
> 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?
> My first proposal would be to try to get Doxygen into something more like book style - meaning leading the unaware reader to a starting point and offer a reading thread. No idea if that is possible, but I think it would help.
> I also wonder in how far requirements can be documented with Doxygen.
> But the first question is:
> How am I going to do this formally?
> Should I open an Enhancement Bug and feed it with patches as I go along?
> Or should I iteratively attach whole tar archives with the Doxygen html result as I would propose it for review?
You can use Doxygen to build any arbitrary web site, though it's not necessarily the best way. I used it to build the project website for wxGuiTesting http://wxguitest.sourceforge.net/ several years ago.
Just attach patches. It's easy to apply them, build the Doxygen docs, and review the results.
But maybe it's better to get replace all of the (mostly outdated) design documentation in the code base with a set of wiki pages and leave Doxygen to document only the API. That's a much easier editing and collaborative flow than Doxygen patches and I suspect that it has a better chance of being maintained going forward.
More information about the gnucash-devel