bug-hurd
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Doxygening Mach and Hurd


From: Michael Casadevall
Subject: Re: Doxygening Mach and Hurd
Date: Fri, 13 Jul 2007 22:46:57 -0400

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

That's what I thought.

I figure its good to include how you use doxygen for those of us who's never used it:
http://www.stack.nl/~dimitri/doxygen/docblocks.html

It also forces everyone to use a standardized commenting style :-). As an added bonus, its
also available for Hurd already :-)

Michael
On Jul 13, 2007, at 10:09 PM, Sam Douglas wrote:

I think it sounds like a good idea; especially for encouraging new
developers to start working on the code base.

-- Sam

On 7/14/07, Michael Casadevall <sonicmctails@gmail.com> wrote:


---------- Forwarded message ----------
Date: Fri, 13 Jul 2007 16:07:23 -0400 (EDT)
From: Michael Casadevall <mcasadevall@gmail.com>
To: bugs-hurd@gnu.org
Subject: Doxygening Mach and Hurd

During my time correcting the entropy patch to meet the requirements to be accepted, I noticved the coding style would make it extremely easy to doxyify
the codebase.

For those of you unfamilar with Doxygen, its similar
to Javadoc and other solutions that use markup in the code
base to generate documentation. I believe one of the bigger
problems with mach, and especially getting new developers is
that mach itself is fairly undocumented, especially its internals
(the only real documentation of IPC I know if is Thomas' guide).
I think it would be in the projects best interests if we start
doxyifing the codebase (which is fairly easy to do; I learned
how to use use doxygen in about five minutes the first time
I ever used it).

Any thoughts and comments on doxygening the codebase?
Michael


_______________________________________________
Bug-hurd mailing list
Bug-hurd@gnu.org
http://lists.gnu.org/mailman/listinfo/bug-hurd



_______________________________________________
Bug-hurd mailing list
Bug-hurd@gnu.org
http://lists.gnu.org/mailman/listinfo/bug-hurd

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.6 (Darwin)

iD8DBQFGmDkhV/FBeJ6jsZQRAqwLAJwLUu30zZg1ep3IijzoD++7AqIS/wCeNikx
bZfdGK87pjwCbg3kWZP/vp8=
=hEjt
-----END PGP SIGNATURE-----




reply via email to

[Prev in Thread] Current Thread [Next in Thread]