API documentation requirements for next releases

[Federico Mena Quintero <federico ximian com>]

Hi,

Some time ago we discussed adding a requirement for new APIs that enter
the core platform [1]:  those modules which add new APIs must provide
documentation for those APIs.  Thanks to Murray for bringing it up, and
for resurrecting the discussion.

The release team has decided that we'll try this plan for the 2.14
release.  If it works out well, we'll use it for subsequent releases as
well.  You can see the details here:

	http://live.gnome.org/ReleasePlanning/NewApiDocs

Summary:

For modules in the core platform [2], we'll require that new APIs and
other public interfaces have documentation.  This includes C functions,
configuration files, GConf keys, and anything that is not internal only.

     1. Document any new public interfaces since the last stable version
        of the module (e.g. the jump from 2.12.x to 2.14.0). You can do
        this with gtk-doc.
     2. Mark any newly deprecated interfaces as such.
     3. Any new module proposed for the platform must be fully
        documented. 
        

[1] http://mail.gnome.org/archives/desktop-devel-list/2005-November/msg00216.html

[2] http://live.gnome.org/TwoPointThirteen/Platform
-- 
Federico Mena Quintero <federico ximian com>