Re: some questions about gtk-doc

[Matthias Clasen <mclasen redhat com>]

On Fri, 2005-08-05 at 23:47 +0200, Thomas Vander Stichele wrote:
> Hi everyone,
> 
> I've been delving a bit deeper into gtk-doc recently because I wanted to
> add documentation for plugins and elements in GStreamer.
> 
> While doing so I've come across a few things I wanted to ask:
> 
> a) it looks to me like enums that are registered with glib aren't
> extracted; only the C-level enums are.  In GStreamer, a tool called
> gst-inspect extracts the extra information from registered enums when
> describing signals and properties, which looks like this:
> 
>   recover-policy      : How to recover when client reaches the soft max
>                         Enum "GstTCPRecoverPolicy" (default 0, "Do not
> try to recover")
>                            (0):         Do not try to recover
>                            (1):         Resync client to most recent
> buffer
>                            (2):         Resync client to soft limit
>                            (3):         Resync client to most recent
> keyframe
> 
> Any reason why gtk-doc doesn't have this ? What would be the best way to
> add this - have the scanner write a .enums file, and then incorporate
> this ?

Sounds reasonable. You need to be careful to merge this information in
a sensible way with stuff found in templates or inline, though. But
registered enumerations only have nicks and names for their values, not
the short blurbs your example shows...

> 
> P.S.: anyone ever considered redoing gtk-doc in, say, python ?
> 

No why ? 

Matthias