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

[Stefan Kost <kost imn htwk-leipzig de>]

hi hi,

Peter Williams wrote:
> 
> Maybe let the developer be able to specify the default stability: via a
> command-line flag, or at the top of each source file, etc. Such as:
> 
> 	gtk$ gtkdoc-mkdb --default-stability=Stable ...
> 
> 	libwnck$ gtkdoc-mkdb --default-stability=Private
> 
> And if the developer doesn't bother, go with Undefined.

that sounds good to me. Fits with the gtkdoc concept. And if the default does
not fit entries than one still can put them in the file. Would be nice if one
could say that e.g. everything in gtk+-2.5 that wasn't there in 2.4 is
considered unstable ...

As an extension it would be thinkable to specify the default stababillity in the
section comment as well (when that is implemented).

/**
 * SECTION:gtkaboutdialog
 * @summary: Display information about an application
 * @see: #GtkDialog
 * @stabillity: Stable
 *
 * The #GtkAboutDialog offers a simple way to display information
 * about a program like its logo, name, copyright, website and license.
 */

Still parts can overide this (e.g. a new methods that needs testing).

Stefan
-- 
      \|/            Stefan Kost
     <@ @>           private            business
+-oOO-(_)-OOo------------------------------------------------------ - - -  -   -
|       __  Address  Simildenstr. 5     HTWK Leipzig, Fb IMN, Postfach 301166
|      ///           04277 Leipzig      04251 Leipzig
| __  ///            Germany            Germany
| \\\///    Phone    +49341 2253538     +49341 30766101
|  \__/     EMail    st_kost_at_gmx.net kost_at_imn.htwk-leipzig.de
|           WWW      www.sonicpulse.de  www.imn.htwk-leipzig.de/~kost/about.html
===-=-=--=---=---------------------------------- - - -  -    -

begin:vcard
fn:Stefan Kost
n:Kost;Stefan
org:HTWK Leipzig;FB. IMN
adr:;;Postfach 301166;Leipzig;;04251;Germany
email;internet:kost imn htwk-leipzig de
title:Dipl. Informatiker
tel;work:+49341 30766440
tel;home:+49341 2253538
tel;cell:+49178 3183742
x-mozilla-html:FALSE
url:http://www.imn.htwk-leipzig.de/~kost/about.html
version:2.1
end:vcard