ubuntu-webapps-bugs team mailing list archive
-
ubuntu-webapps-bugs team
-
Mailing list archive
-
Message #00155
[Bug 1241029] Re: Cannot generate API web docs from source
This bug was fixed in the package ubuntu-html5-theme -
0.1+14.04.20140107-0ubuntu1
---------------
ubuntu-html5-theme (0.1+14.04.20140107-0ubuntu1) trusty; urgency=low
[ Adnane Belmadiaf ]
* s/parentNode/parendNode Spaces instead of tabs. (LP: #1241215)
* Add option selector widget. (LP: #1232533)
[ daker ]
* Passe the UI variable name so we will not lock the variable. (LP:
#1222878)
* Made variable declaration locale. (LP: #1222881)
* Fixed z-index for the list items aside. (LP: #1223973)
* s/parentNode/parendNode Spaces instead of tabs. (LP: #1241215)
* Space instead of tab. (LP: #1240682)
* Made list items with headers differentes. (LP: #1246446)
* Updated the progressbar component to match the design.
* Move tabs closer to what they should be, Expand API to match the QML
one (at least at the Tabs level), .
* Add option selector widget. (LP: #1232533)
[ Kyle Nitzsche ]
* Add button id to "Invalid button ID" error message .
* This MR does three main things: 1) Implements yuidoc comments in all
js files to support API doc generation, and provides yuidoc assets
(theme dir and json file) needed to build the API docs. Bug LP:
#1241029 3) Provides JS classes for shape and page with
corresponding UbuntuUI prototype constructor functions. Bug LP:
#1243248 4) Adds a getEl(UbuntuUIObject) to return the element for
any Ubuntu class. Also LP: #1243248. (LP: #1243248, #1241029)
[ Colin Watson ]
* Make ubuntu-html5-theme Multi-Arch: foreign.
[ Alexandre Abreu ]
* Fix exec path in app-gallery app desktop file. (LP: #1235321)
* Add convenient element() function to most widgets ... (we might want
to factor those out in a second step).
* Move tabs closer to what they should be, Expand API to match the QML
one (at least at the Tabs level), .
* Add HTML5 webapp container package.
[ Ubuntu daily release ]
* Automatic snapshot from revision 98
-- Ubuntu daily release <ps-jenkins@xxxxxxxxxxxxxxxxxxx> Tue, 07 Jan 2014 23:46:53 +0000
** Changed in: ubuntu-html5-theme (Ubuntu)
Status: New => Fix Released
--
You received this bug notification because you are a member of Ubuntu
WebApps bug tracking, which is subscribed to ubuntu-html5-theme in
Ubuntu.
https://bugs.launchpad.net/bugs/1241029
Title:
Cannot generate API web docs from source
Status in Ubuntu UI SDK for HTML5 Apps:
Fix Committed
Status in “ubuntu-html5-theme” package in Ubuntu:
Fix Released
Bug description:
Today, we cannot generate JavaScript API web docs for from the source
JavaScript.
(A community member (Daniel Beck thanks!) has put together an
excellent set of pages [1] instructing how to use the Ubuntu HTML5
widgets including overall explanation, the JavaScript API, and some
content on CSS. But these appear hand-crafted and not generated from
source. )
It seems important to be able to generate API docs from source automatically for at least these reasons:
* Automation and maintenance: When a new version is released, there should be a clear path to generating the API docs and publishing them, with no handcrafting required
* Engineering responsibility: placing the API doc content in the source itself clearly makes engineers who change the API responsible for keeping the API docs synchronized
To this end, I implemented a first pass at adding comments to source such that API docs can be generated. I used yuidoc format.
* Here's what is generated today: http://people.canonical.com/~knitzsche/yuidoc-ubuntu-html5-theme/17oct2013/
* Here's the branch that includes the yuidoc from which that was produced: https://code.launchpad.net/~knitzsche/ubuntu-html5-theme/ubuntu-html5-theme-yuidoc
Some parts are not yet done (lists.js (now done), toolbars.js,
popovers. fastbuttons.js)
Many are "done" to first pass level: core.js, pagestack.js, tabs.js,
dialogs.js, buttons.js.
The generated web pages are (obviously) not Ubuntu themed, which can
be changed.
Is there a good reason to use a different system (jsdoc for instance)?
[1] http://daniel-beck.org/ubuntu-html5-theme/widgets/
To manage notifications about this bug go to:
https://bugs.launchpad.net/ubuntu-html5-theme/+bug/1241029/+subscriptions