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
A library to be consumed by clients that want deep integration with the Unity shell

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
Dconf Qt Bindings

non-GObject based

No, bug 716330

desrt

libappindicator
Allows applications to export a menu into the Unity Menu bar

Yes

libappindicator (C, gtk-doc)

ted & kenvandine

libdee
DBus extensions library

Yes

dee-1.0 (C, gtk-doc)

kamstrup

libzeitgeist
A library for applications that want to interact with the Zeitgeist daemon

No, bug 716333

libzeitgeist (C, gtk-doc)

kamstrup

libgrip
Gives GTK+ applications the ability to use multitouch gestures

Yes

[[http://developer.ubuntu.com/api/ubuntu-11.10/c/grip]|grip] (C, gtk-doc)

Satoris & bregma

libgwibber
Makes it easier for desktop applications to integrate with social networks through the Gwibber service

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
Allows access to desktopcouch databases, on top of libcouch-glib

Yes

libdesktopcouch-glib (C, gtk-doc)

aquarius & rodrigo

Available in the libcouch-glib-doc package

desktopcouch.records
Allows access to desktopcouch databases for Python apps

non-GObject based

No, bug #

aquarius

Python API, Stuart is working on documenting it for the U1 dev site through the docstrings

libdbusmenu
Passes a menu structure across DBus so that a program can create a menu simply

Yes

libdbusmenu-glib (C, gtk-doc)

ted

libdbusmenu-gtk
DBusMenu GTK bindings

Yes

libdbusmenu-gtk (C, gtk-doc)

ted

libdbusmenu-qt
Qt implementation of the DBusMenu spec

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
Pygtk Widgets and other modules

No

No, bug 725029

rickspencer3

libindicate
Allows applications to share messages over dbus

Yes

libindicate (C, gtk-doc)

ted

libqtdee
Qt bindings for the DBus extensions library

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
Application matching framework

libbamf (C, gtk-doc)

libindicator
A set of symbols and convenience functions that all indicators would like to use

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 chasedouglas)