Scanning for signal prototypes

[Roger Leigh <rleigh whinlatter ukfsn org>]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hi folks,

I've just added gtk-doc support to a new project I'm working on.  The
code is here:

  http://www.whinlatter.ukfsn.org/gtk/uterm-0.1.0.tar.bz2

I think I've set it up correctly.  I've added the Makefiles, configure
macro and then set up the .type and sections.txt files.  It works but
for one thing: the signal prototypes in the docs don't match the
marshaller or the class method.  For example
(uterm/uterm-code-table.c):

  table_signals[SIGNAL_CHAR_CHANGED] =
    g_signal_new ("character-changed",
		  G_OBJECT_CLASS_TYPE(klass),
		  G_SIGNAL_RUN_FIRST | G_SIGNAL_ACTION,
		  G_STRUCT_OFFSET (UtermCodeTableClass, character_changed),
		  NULL, NULL,
		  g_cclosure_marshal_VOID__UINT,
		  G_TYPE_NONE, 0);

and in the header:

struct _UtermCodeTableClass
{
  GObjectClass		     parent;
  void (* character_changed) (UtermCodeTable *table,
			      int             index);

};

In the docs, I get this:

  The "character-changed" signal

  void        user_function                  (UtermCodeTable *utermcodetable,
                                              gpointer user_data);

  utermcodetable :	the object which received the signal.
  user_data :	user data set when the signal handler was connected.

The uint parameter was missed out!  Do I need to do anything special
for it to detect the prototype?  I thought this would be detectable
through the marshaller in use or the virtual class method prototype.
Can these be documented inline, or only in the templates?


The other problem I've run into is that gtkdoc-mkdb (and -mktmpl)
can't scan C99 restricted pointers (filed in bugzilla as #165067).  I
can take a stab at adding this, if I know where to add it (I'm afraid
I'm neither a Perl nor a regex guru, so I've failed so far).


Many thanks,
Roger

- -- 
Roger Leigh
                Printing on GNU/Linux?  http://gimp-print.sourceforge.net/
                Debian GNU/Linux        http://www.debian.org/
                GPG Public Key: 0x25BFB848.  Please sign and encrypt your mail.
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.5 (GNU/Linux)
Comment: Processed by Mailcrypt 3.5.8 <http://mailcrypt.sourceforge.net/>

iD8DBQFB9+XQVcFcaSW/uEgRAs+tAKC1v40ceWnQsiwM9iF2xx7tDkLZIQCgnBDE
3txBeH7yOCIOiOgzlgaBXvY=
=WOFY
-----END PGP SIGNATURE-----