DeveloperUbuntuComApi
Developer Portal API Documentation
This is a temporary page to coordinate the effort of publishing automatically-generated API documentation for multiple language bindings from a central location at developer.ubuntu.com
For now, it mostly contains a list of all Canonical-developed APIs with links to the existing documentation resources in order to provide an overview.
Ubuntu APIs
Public APIs
API |
Implements Introspection? |
Has Documentation? |
Contact |
Notes |
libunity |
Yes |
No, bug 589091 |
kamstrup |
Written in Vala. Documentation currently blocked by the fact that annotations and docstrings are not passed on to the generated code. Also see bug 709240 |
dconf-qt |
non-GObject based |
No, bug 716330 |
desrt |
|
libappindicator |
Yes |
libappindicator (C, gtk-doc) |
ted & kenvandine |
|
libdee |
Yes |
dee-1.0 (C, gtk-doc) |
kamstrup |
|
libzeitgeist |
No, bug 716333 |
libzeitgeist (C, gtk-doc) |
kamstrup |
|
libgrip |
Yes |
[[http://developer.ubuntu.com/api/ubuntu-11.10/c/grip]|grip] (C, gtk-doc) |
Satoris & bregma |
|
libgwibber |
Yes |
No, bug 716335 |
kenvandine |
Written in Vala. Documentation currently blocked by the fact that annotations and docstrings are not passed on to the generated code. |
libdesktopcouch-glib |
Yes |
libdesktopcouch-glib (C, gtk-doc) |
aquarius & rodrigo |
Available in the libcouch-glib-doc package |
desktopcouch.records |
non-GObject based |
No, bug # |
aquarius |
Python API, Stuart is working on documenting it for the U1 dev site through the docstrings |
libdbusmenu |
Yes |
libdbusmenu-glib (C, gtk-doc) |
ted |
|
libdbusmenu-gtk |
Yes |
libdbusmenu-gtk (C, gtk-doc) |
ted |
|
libdbusmenu-qt |
non-GObject based |
Yes, but bug 724214 libdbusmenu-qt (C++, doxygen) |
agateau |
Documentation available, -doc package missing, Aurélien is going to have one soon |
Quickly Widgets |
No |
No, bug 725029 |
rickspencer3 |
|
libindicate |
Yes |
libindicate (C, gtk-doc) |
ted |
|
libqtdee |
non-GObject based |
No, bug # |
agateau |
Right now the only consumer is unity 2D. The binding is not yet complete. Documentation is planned to be added but the work has not been scheduled |
Internal APIs
Nice to have, but less critical to document or have bindings for, since they're only used internally by Unity or applications we maintain.
API |
Implements Introspection? |
Has Documentation? |
Contact |
Notes |
libbamf |
|
libbamf (C, gtk-doc) |
|
|
libindicator |
Planned |
|
ted |
|
Note: we're not listing Nux here, as it is an internal toolkit and we're not positioning it for 3rd-party application developers
Ubuntu One APIs
Stuart Langridge recommends to consider the Ubuntu One APIs separately for now, and publish their documentation on the Ubuntu One developer site. Most of the Ubuntu One APIs are not delivered by client programs on the Ubuntu desktop (such as the Web API) and cannot be documented using the same tools.
For more information, get in touch with Stuart.
Documentation Tools
More info on available documentation tools
DeveloperUbuntuComApi (last edited 2012-06-14 23:26:44 by c-67-170-185-42)