Re: Documenting properties and signals with gtk-doc



I believe (I think) signals and properties are found at build time by
starting up your library and walking the classes you define.

You need to add a bit more machinery to your Makefile.am to help it
run g-ir-scanner for you. There's a page on the wiki about this:

https://wiki.gnome.org/action/show/Projects/GObjectIntrospection/AutotoolsIntegration?action=show

I couldn't see most of that stuff in your project, perhaps I missed it.

John



On 20 December 2014 at 12:39, Wouter Verhelst <w uter be> wrote:
Hi list,

I've been pouring over the (fairly scarce) documentation and trying to
fix things for several hours last night (until the wee hours of the
morning, in fact), but so far haven't been able to figure this out:

I wrote a library to deal with joysticks in a GObject/GTK-like way. It
works (including a GTK-based tester tool, although the UI could use some
improvement), and I now want to do the API documentation and also make
sure that glib-introspection works.

However, I do not seem to be able to get the documentation that I wrote
for the few signals and properties to actually show up in the gtk-doc
output. It just isn't there.

I'm sure this must be something obvious to someone more experienced with
gtk-doc than me, but I don't see it.

Help?

The code is at https://github.com/yoe/libjoy

Thanks,

--
It is easy to love a country that is famous for chocolate and beer

  -- Barack Obama, speaking in Brussels, Belgium, 2014-03-26
_______________________________________________
gtk-app-devel-list mailing list
gtk-app-devel-list gnome org
https://mail.gnome.org/mailman/listinfo/gtk-app-devel-list


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