unity-webapps-qml

docs src format needs fixing

Bug #1274191 reported by Kyle Nitzsche on 2014-01-29

This bug affects 1 person

Affects		Status	Importance	Assigned to	Milestone
	unity-webapps-qml	Fix Released	High	Alexandre Abreu
	unity-webapps-qml (Ubuntu)	Fix Released	Undecided	Unassigned

Bug Description

yuidoc is the doc build system.

The yuidoc build of the unity-webapps-qml API docs for JavaScript fails to produce usable content because yuidocs requirements are not met. (The build succeeds but there are no useful pages.)

I think the problem is that there must be @class and@module yuidoc params in source, but there are none.

For example look here:
http://bazaar.launchpad.net/~ubuntu-html5-theme-devs/ubuntu-html5-theme/trunk/view/head:/0.1/ambiance/js/buttons.js

And you will see this:
/**
* A Button.

Note the Ubuntu CSS style classes: <em>success</em>, <em>warning</em>, and <em>danger</em>

* @class Button
* @constructor
* @namespace UbuntuUI
* @example
<button data-role="button" id="buttonID">text</button>

Javascript access:
var button = UI.button("buttonID");
*/

These requirements are explained here: http://yui.github.io/yuidoc/syntax/

Tags:

Related branches

lp:~abreu-alexandre/unity-webapps-qml/yuidocs-fix

Merged into lp:unity-webapps-qml at revision 81

David Barth (community): Approve on 2014-02-11

PS Jenkins bot (community): Approve (continuous-integration) on 2014-02-10

lp:ubuntu/trusty-proposed/unity-webapps-qml

Revision history for this message

Kyle Nitzsche (knitzsche) wrote on 2014-01-29:

This shows how I generate html docs from yudioc formatted JS src in ubuntu-html5-theme:
https://bugs.launchpad.net/ubuntu-html5-theme/+bug/1241029/comments/16

Revision history for this message

Kyle Nitzsche (knitzsche) wrote on 2014-02-07:

yudico-theme-assets.zip Edit (34.9 KiB, application/zip)

@Alex: Attaching the two yuidoc theme assets in a zip:
1) the yuidoc.json file
2) the yuidoc-theme dir

When you have them in the directory that contains the marked up .js and build it with: "yuidoc -c yuidoc.json . " it creates the nicely formatted, ubuntu themed html version.

Changed in unity-webapps-qml:
assignee:	nobody → Alexandre Abreu (abreu-alexandre)

Alexandre Abreu (abreu-alexandre) on 2014-02-10

Changed in unity-webapps-qml:
importance:	Undecided → High
status:	New → In Progress

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-02-11:

Fix committed into lp:unity-webapps-qml at revision 81, scheduled for release in unity-webapps-qml, milestone Unknown

Changed in unity-webapps-qml:
status:	In Progress → Fix Committed

Revision history for this message

Launchpad Janitor (janitor) wrote on 2014-02-11:

This bug was fixed in the package unity-webapps-qml - 0.1+14.04.20140211.1-0ubuntu1

---------------
unity-webapps-qml (0.1+14.04.20140211.1-0ubuntu1) trusty; urgency=low

[ CI bot ]
* Null merge to trigger a CI Train trunk release.

  [ Alexandre Abreu ]
  * Fix content hub export.
  * "Move the content hub depends to a suggests to avoid pulling click
    deps on the desktop".
  * Fix the inline docs to work properly with yuidocs. (LP: #1274191)
  * Simplify content hub application import action through an extra api
    that basically wraps it all. .
-- Ubuntu daily release <email address hidden> Tue, 11 Feb 2014 20:02:20 +0000