Please create a documentation package

Bug #1195792 reported by David Planella on 2013-06-28
24
This bug affects 4 people
Affects Status Importance Assigned to Milestone
gsettings-qt
Undecided
Unassigned
gsettings-qt (Ubuntu)
Undecided
Unassigned

Bug Description

In order for app developers to be able to use the GSettings API with the Ubuntu SDK, we need good documentation.

Ideally, we'd have well documented examples, classes and its members, but the very first step is to get documentation built at all.

In the same way we do with the ubuntu-ui-toolkit, we need a -doc package for GSettings QML module, which builds and ships the HTML documentation generated from qdoc. Once we've got that, I can get that documentation to be automatically published on developer.ubuntu.com from the -doc package.

The ubuntu-ui-toolkit-doc package and ubuntu-ui-toolkit branch (see the documentation folder) are a good example about creating the HTML with developer.ubuntu.com CSS styling.

Thanks!

Launchpad Janitor (janitor) wrote :

Status changed to 'Confirmed' because the bug affects multiple users.

Changed in gsettings-qt (Ubuntu):
status: New → Confirmed
To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers