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

I think the problem is that there must be @class and/@module yuidoc
lines 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/


** Changed in: ubuntu-html5-theme
       Status: Fix Committed => Confirmed

** Changed in: unity-webapps-qml (Ubuntu)
       Status: Fix Committed => Confirmed

-- 
You received this bug notification because you are a member of Ubuntu
Bugs, which is subscribed to Ubuntu.
https://bugs.launchpad.net/bugs/1270210

Title:
  Add javascript first binding support for Ubuntu APIs

To manage notifications about this bug go to:
https://bugs.launchpad.net/ubuntu-html5-theme/+bug/1270210/+subscriptions

-- 
ubuntu-bugs mailing list
ubuntu-bugs@lists.ubuntu.com
https://lists.ubuntu.com/mailman/listinfo/ubuntu-bugs

Reply via email to