Re: linking to signals

[Damon Chaplin <damon karuna eclipse co uk>]

On Sat, 2007-05-26 at 21:44 -0400, Matthias Clasen wrote: 
> I've recently started to use the #GtkWidet::expose-event syntax that was
> introduced some time ago to create links to signal documentation. It is
> really great to have this convenient syntax for it, but here are two
> things that I think should be improved:
> 
> a) While it is necessary to specify the class to uniquely identify a
> signal, in practice there is rarely confusion about which class a signal
> belongs to. Therefore, I'd welcome it if we could simplify the formatted
> link text in the output to just ::signal-name.

Yes, that would probably look better.


> b) The link syntax moves ::signal-name closer to being the "official"
> way to refer to signals in the docs. It would therefore be more
> consistent if the autogenerated signal docs would also use ::signal-name
> in their title, instead of "signal_name".

That is probably OK too, as long as it is still obviously a signal.

Damon