Re: Fwd: gtk+ documentation wikified

[Mathias Hasselmann <mathias hasselmann gmx de>]

Am Donnerstag, den 19.02.2009, 17:52 +0200 schrieb Eugene Gorodinsky:
> Have there been cases where documentation for some function was
> changed after that function appeared in the stable version?

Yes, this happens frequently: Spelling errors, explanations of
limitations, code examples, usage scenarios, ...

In the end programmers primary are programmers, not book writers.
Therefore API documentation provided by programmers always can be just a
start. Still API documentation should be close to programmer's finger
tips, 'cause otherwise the documentation will start to bit rot quickly.

Ciao,
Mathias

> 
> 2009/2/19 Dominic Lachowicz <domlachowicz gmail com>:
> > That's hard-ish to do today. GTK+'s documentation is generated in
> > large part by scanning comments in C code, which a program then turns
> > into HTML. Any proposal would require a way to keep the Wiki and -the C
> > comments in-sync.
> >
> > On Thu, Feb 19, 2009 at 10:28 AM, Eugene Gorodinsky
> > <e gorodinsky gmail com> wrote:
> >> Hi all
> >>
> >> Since you guys are discussing the redesign of the gtk+ website, I'd
> >> like to propose an idea that I have. I've seen quite a lot of comments
> >> saying gtk+ documentation isn't as good as qt's. What do you think of
> >> having a wiki that documents all of gtk+ api?
> >> _______________________________________________
> >> gtk-devel-list mailing list
> >> gtk-devel-list gnome org
> >> http://mail.gnome.org/mailman/listinfo/gtk-devel-list
> >>
> >
> >
> >
> > --
> > Counting bodies like sheep to the rhythm of the war drums.
> >
> _______________________________________________
> gtk-devel-list mailing list
> gtk-devel-list gnome org
> http://mail.gnome.org/mailman/listinfo/gtk-devel-list
> 

-- 
Mathias Hasselmann <mathias hasselmann gmx de>
Personal Blog: http://taschenorakel.de/mathias/
Openismus GmbH: http://www.openismus.com/