[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: Doxygening Mach and Hurd
From: |
Constantine Kousoulos |
Subject: |
Re: Doxygening Mach and Hurd |
Date: |
Sun, 15 Jul 2007 12:31:53 +0300 |
User-agent: |
Mozilla-Thunderbird 2.0.0.4 (X11/20070621) |
GNU Mach would greatly benefit from doxygen if we used it (quoting the
official site) "to extract the code structure from undocumented source
files. This is very useful to quickly find your way in large source
distributions. You can also visualize the relations between the various
elements by means of include dependency graphs, inheritance diagrams,
and collaboration diagrams, which are all generated automatically." This
doxygen feature requires just a configuration file and no modifications
to the existing source code, so it's something trivial to achieve.
GNU Mach source code is undocumented and at the same time a bit of a
mess :). Having doxygen for an overview of the existing relations, it
would speed up modifications and source code inspection (from newbies or
not). I have used this kind of "documentation" on other projects and it
helps a lot.
For those of you who do not know what i am talking about, check out this
site i randomly found while googling for microkernels:
http://www.helenos.eu/doc/refman/kernel-ia32/.