Re: API documentation

James Muir said:
I've downloaded some xs files:

-rw-r--r--  1 james james 17402 2005-09-21 16:19 GnomeCanvas.xs
-rw-r--r--  1 james james  7508 2005-09-21 15:04 GnomeCanvasItem.xs
-rw-r--r--  1 james james  2695 2005-09-21 15:02 GnomeCanvasRichText.xs

but I don't see all of the documentation. Where is the documentation for
the Gnome2::Canvas::Text properties coming from? Did I miss something?

Ah.  Yes.  The documentation for GObject properties comes from the "blurb"
attached to each property's ParamSpec at creation time.  So, for the
"cursor-visible" property Gnome2::Canvas::RichText, the documentation text,
"Is the cursor visible in this rich text item?" exists in this file:

Yes, that is over in the C library.  (Search for "PROP_CURSOR_VISIBLE".)

So, if you want to change a property description, you have to contact the
people in charge of the actual g_object_class_install_property() call.

If you want to add a synopsis or description or see also or method
description, then just edit the POD.

Sorry about that.

muppet <scott at asofyet dot org>

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