Re: need people to add documentation to glib?
- From: Guido Draheim <guidod-2003- gmx de>
- To: gtk-list gnome org
- Subject: Re: need people to add documentation to glib?
- Date: Wed, 09 Apr 2003 19:10:43 +0200
Silence again?
Anyway, how to bring up a decision that
(a) glib methods should be fully documented with their set of
pre-conditions and post-conditions. A lot of functions
have some check-functions in their implementation to
print a warning and return with a value which can help
in deriving pre-conditions and that should be in the
docs so that developers don't need to read the source
code of glib.
(b) create extensions on the documentation processor to
get at a docbook master xml file that can be turned
into proper troff man pages. It would need to include
per-function manpages and it would be good to have them
contain cross-references to overview pages that decribe
in short words a function family and their design.
thank you, guido http://xmlg.sf.net
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]