Re: Contribution (updating documentation)

[Murray Cumming <murrayc murrayc com>]

On Tue, 2014-02-18 at 10:08 +0100, Kjell Ahlstedt wrote:
> of course the glib/gtk+ documentation does not mention exceptions.

However, it can and should mention the types of errors that it can
produce. The GFile API is pretty good about this, for example, though it
mentions specific error codes rather than generic error types (GIOError
in this case):
https://developer.gnome.org/gio/stable/GFile.html#g-file-read

We rewrite that documentation in terms of exceptions for C++. For
instance:
https://developer.gnome.org/glibmm/stable/classGio_1_1File.html#a3ef959c7ad7096846f26eb8b282e3c68

I think it's worth filing bugs about GTK+ documentation that doesn't do
this, because it's really part of the API. However, C developers can
sometimes find it harder to see that.

Murray

-- 
murrayc murrayc com
www.murrayc.com
www.openismus.com