Re: Interface Stability (was Re: xxx-undocumented.txt)

[Damon Chaplin <damon karuna uklinux net>]

On Fri, 2005-01-28 at 20:48, Brian Cameron wrote:
> Damon:
> 
> Okay, I've updated the patch.  Now it works as follows:
> 
> If the user specifies "--default-stability-level=LVL" argument, or if the
> user has defined the following section in the tmpl file:
> 
>    <!-- ##### SECTION Stability_Level ##### -->
>    LVL
> 
> Then the following appears at the top of the generated page, just under
> the title/description and before the Synopsis.
> 
>    Stability Level
>    LVL, unless otherwise indicated
> 
> If the user defines a @Stability argument in the tmpl file or a
> "* Stability: LVL" comment in the docs for a given interface, then the
> interface includes the following text in the generated output.
> 
>    Stability Level: LVL
> 
> I think this addresses all the concerns.  This makes it easy for the module
> maintainer to manage.  They can define defaults at the gtkdoc-mkdb command
> line, or in the tmpl file.  For interfaces that are exceptions, it is only
> necessary to add the Stability tag to the specific interfaces.

Thanks. I've committed that, with a few minor changes.

I've also just committed Stefan's patch to support adding the section
documentation in the source code, so we could support @stability: there
as well:
  http://bugzilla.gnome.org/show_bug.cgi?id=165963

We also need to update the gtk-doc.make file to pass any required
"--default-stability-level=LVL" flag.

Damon