The api docs are incomplete or missing

[Shane Fagan]

Binary package hint: indicator-application

The docs on http://people.canonical.com/~ted/libappindicator/current/index.html have a lot of 404 not founds.

ProblemType: Bug
Architecture: amd64
Date: Wed Mar 10 23:00:41 2010
DistroRelease: Ubuntu 10.04
InstallationMedia: Ubuntu 10.04 "Lucid Lynx" - Alpha amd64 (20100308)
Package: indicator-application 0.0.15-0ubuntu1
ProcEnviron:
 PATH=(custom, user)
 LANG=en_IE.utf8
 SHELL=/bin/bash
ProcVersionSignature: Ubuntu 2.6.32-16.24-generic
SourcePackage: indicator-application
Uname: Linux 2.6.32-16-generic x86_64

[Jorge Castro (jorge)]

Ted we should probably find a more permanent home for these.

[Sense Egbert Hofstede (sense)]

I would say that the issue with the documentation on the internet is more something for the indicator-application project alone, and not so much for the 'indicator-application' source package in the 'ubuntu' project, but maybe it's good to keep that task open since it could be good to take a look at the packaged documentation as well.

[Sense Egbert Hofstede (sense)]

Setting the bug to Triaged in Ubuntu and Confirmed in the upstream project as someone really should take a look at this. That was Jorge, so I'll assign it to him.

The status is set to Medium based on the importance of the documentation for this project.

[Ted Gould (ted)]

We're currently checking the docs in make check to ensure that the code is properly documented upstream. I think that's the main upstream task here. So I'm closing that task.

[David Planella (dpm)]

We're working on generating documentation automatically on a permanent home at developer.ubuntu.com/api, but this is still ongoing work.

You can track the status on https://wiki.ubuntu.com/DeveloperUbuntuComApi and through bug 704124

Just temporarily, the documentation is being generated daily from that available in the -doc packages at http://people.canonical.com/~dpm/api/natty/ - see the libappindicator folder for that.

Going forward, we are thinking of generating documentation for the bindings available through introspection through processing of the .gir files. Mikkel Kamstrup has already started working on this in the Giraffe project (https://launchpad.net/giraffe), and you can already see a sample of this output in the GIR folder of the URL above.

We'd welcome any help on any of this, as we believe providing good documentation to use our developer platform is essential.

I'll mark this bug as a duplicate of the above. Feel free to unmark it if you think it is in fact not a duplicate.