Re: Documenting properties and signals with gtk-doc



On Sat, Dec 20, 2014 at 03:04:17PM +0100, Colomban Wendling wrote:
Hi,

Le 20/12/2014 13:39, Wouter Verhelst a écrit :
[...]

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.

The problem you have is that your GType type names don't match your
class names.

Thanks! That fixed it, indeed. In hindsight it's obvious that this can't
work; but then, I suppose that's true for all bugs.

[...]
PS: your build system has issues, like the generated files
(joy-marchallers.[ch], joy-iface.h) aren't generated automatically, and
you lack a dependency on libjoy.la and UDEV_LIBS on your libjoy-gtk
library (this breaks building with LDFLAGS=-Wl,-z,defs)

I know. That's part of why it's not released yet :-)

I'll need to fix that up before it's ready, and I will, but obviously I
can't do everything at once. Still, thanks for pointing that out.

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

  -- Barack Obama, speaking in Brussels, Belgium, 2014-03-26


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