After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 351657 - API documentation issues with 2.15 release
API documentation issues with 2.15 release
Status: RESOLVED FIXED
Product: at-spi
Classification: Platform
Component: docs
1.7.x
Other All
: Normal blocker
: ---
Assigned To: bill.haneman
bill.haneman
Depends on:
Blocks:
 
 
Reported: 2006-08-16 19:14 UTC by Brian Cameron
Modified: 2006-08-17 16:44 UTC
See Also:
GNOME target: ---
GNOME version: 2.15/2.16


Description Brian Cameron 2006-08-16 19:14:37 UTC 
The following functions do not seem to have any documentation
in the c-code or in the generated gtk-docs:

spi_document_interface_new
cspi_attribute_set_from_sequence
AccessibleTable_getRowColumnExtentsAtIndex
All of the AccessibleDocument_* interfaces (aside from _ref
and _unref).

The following are documented in the c-code, but not found in
the generated gtk-docs:

AccessibleDocument_ref
AccessibleDocument_unref
AccessibleSelection_deselectChild
AccessibleTable_getRowColumnExtentsAtIndex
AccessibleText_getAttributeRun
AccessibleText_getDefaultAttributeSet
AccessibleValue_getMinimumIncrement
Accessible_getDocument
Accessible_isDocument

None of the new functions seem to have "Since:" tags.

The Release Engineering API/ABI rules for Platform Libraries imply
that properly documenting functions includes making sure they are
actually in the generated gtk-docs and using Since/Deprecated tags as
appropriate:

http://live.gnome.org/ReleasePlanning/ModuleRequirements/Platform
Comment 1 bill.haneman 2006-08-16 19:38:01 UTC 
>spi_document_interface_new
>cspi_attribute_set_from_sequence

Probably should either be static or stripped to package-private-ness.

>AccessibleTable_getRowColumnExtentsAtIndex
>All of the AccessibleDocument_* interfaces (aside from _ref
>and _unref).

Should copy-and-paste from the IDL docs for the same methods.

>The following are documented in the c-code, but not found in
>the generated gtk-docs:
> ...

Probably need to add those to atk-sections.txt.

Thanks for catching these.
Comment 2 bill.haneman 2006-08-17 16:44:43 UTC 
I've made the relevant changes to the sections.txt file and cut-n-pasted a few lines of docs.  Fixed in CVS.