Documentation/Patching API docs

There are three possible places you should go to make a change to API documentation, depending on the package:


 * 1) Upstream API
 * 2) Open Maemo-specific API
 * 3) Closed Maemo-specific API

Upstream API
Example: Maemo bug #4716


 * Open a bug in Maemo bugzilla for the API documentation issue
 * Open a corresponding bug upstream for the issue, and add a pointer to the upstream bug to the maemo.org bug
 * Get the source code of the upstream module from its source control system (in the case of gnome-vfs, that is git)
 * Patch the upstream source code to correct the documentation issue, and attach a patch (generated with git diff or git format-patch ) to the upstream bug
 * (optionally) prepare a patch for the Maemo package (typically in gitorious nowadays). Alternately, refer to the upstream commit.
 * Assign bug to (name to be filled - this used to be Soumya) to update the API docs for the module once the fix has been integrated

Maemo specific API
Example: Maemo bug #4337


 * Open a bug in Maemo bugzilla for the API documentation issue
 * Get the source code of the module from gitorious (in the case of libhildondesktop, that is the freemantle-hildon-desktop module)
 * Patch the source code to correct the documentation issue, and attach a patch (generated with git diff or git format-patch ) to the bug. See comment #8 of the example bug.
 * Assign bug to the module owner to get the patch applied.
 * Then assign the bug to (name needed - Soumya used to do this) to update the API docs for the module once the fix has been integrated