Re: g_app_launch_context_get_startup_notify_id



hi,

Murray Cumming schrieb:
On Mon, 2008-07-07 at 10:38 -0400, Matthias Clasen wrote:
On Mon, Jul 7, 2008 at 8:02 AM, Murray Cumming <murrayc murrayc com> wrote:

I thought we were talking about
g_app_launch_context_get_startup_notify_id() and
g_app_launch_context_get_display(). They do not say what their
parameters do.
These functions are basically implementation details and are called in
the process of
a launch operation, so the files parameter is supposed to take the
files that are passed
as arguments to the launched application. It is really not very useful
to call these function
outside of a launch operation. The docs should probably say so.

OK. I might try to improve the documentation if nobody else does it
first.

I hate how often our documentation even sometimes just says "@thing: a
#GThing".
I typically use this pattern when documenting the "this" parameter of
an object method.
What else would you say there ?

Yes, for "this" parameters there isn't much more to say. In fact, I
think they should have special status in gtk-doc syntax so you don't
even need to write that.

Murray

For those who are not afraid of perl, patches welcome. I think its a good idea. gtk-doc could use a default string if this/self is not documented. I guess the only challenge is to reliably recognize those.

Stefan


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