Univention Bugzilla – Bug 28018
JavaScript-API-Dokumentation in eigenes Quellpaket auslagern
Last modified: 2012-12-12 21:08:12 CET
Die API-Doku ist soweit integriert. Hilfreich wäre es, wenn die Doku über ein eigenes Quellpaket generiert wird, damit die Build-Zeiten für das Frontend-Paket kürzer sind. +++ This bug was initially created as a clone of Bug #23197 +++ Die JavaScript-API ist derzeit zu einem Teil im Quellcode dokumentiert. Daraus sollte mit den Dojo-Tools eine Dokumentation automatisch erzeugt und paketiert werden: http://dojotoolkit.org/reference-guide/util/doctools.html
Ok, das Paket wurde ausgelagert: univention-management-console-frontend (2.0.66-1) univention-dojo (6.0.2-1) univention-management-console-frontend-doc (2.0.66-1) Ist hierfür ein Changelog benötigt? Das betrifft ja keine Wirklichen Änderungen und in 3.0-2 ist die API eh nicht nutzbar, weil code im Makefile auskommentiert. Jetzt muss beachtet werden, dass mindestens zu jedem Release dieses Paket einmal neu gebaut werden muss, damit die Doku aktuell bleibt.
(In reply to comment #1) > ... > Ist hierfür ein Changelog benötigt? Das betrifft ja keine Wirklichen Änderungen > und in 3.0-2 ist die API eh nicht nutzbar, weil code im Makefile > auskommentiert. → Ja, bitte einen Changelog-Eintrag. Es ist ja ein neues Paket hinzugekommen.
Super. Folgende Sachen sind mir noch aufgefallen: * Klassen beginnend mit "_" werden nicht aufgelistet * Mehrfachvererbung wird nicht korrekt angezeigt (dafür ist wohl der neue Viewer nötig) * Vererbte Elemente (bspw. bei ComboBox) werden nicht angezeigt (bspw. ist dijit.form.ComboBox leer) * Wenn ich auf den Ordner "umc" klicke und eines der Attached Objects auswähle, ist die Referenz nicht lesbar (vielleicht auch ein Viewer-Problem?)
(In reply to comment #3) > Super. Folgende Sachen sind mir noch aufgefallen: > > * Klassen beginnend mit "_" werden nicht aufgelistet > * Mehrfachvererbung wird nicht korrekt angezeigt (dafür ist wohl der neue > Viewer nötig) > * Vererbte Elemente (bspw. bei ComboBox) werden nicht angezeigt (bspw. ist > dijit.form.ComboBox leer) > * Wenn ich auf den Ordner "umc" klicke und eines der Attached Objects auswähle, > ist die Referenz nicht lesbar (vielleicht auch ein Viewer-Problem?) Ok, die neuen dojo1.8 api-viewer und js-doc-parse wurden implementiert und aus univention-dojo und univention-management-console-frontend nach management/univention-management-console-frontend-doc verschoben. Die version wurde auf > aktuelle univention-dojo version erhöht. univention-management-console-frontend-doc 6.0.4-4
Super, das funktioniert jetzt sehr gut! Changelog → OK (Ich habe den einen Changelog-Eintrag bzgl. umc-frontend-src entfernt, da dies nicht eine Änderung der internen Aufteilung ist.) Zu einem späteren Zeitpunkt kann auch das Theme angepasst werden (→ Bug 28843). Kleinigkeiten, die aufgefallen sind (→ Bug 28843): * Der Feedback-Link verweist auf forge.univention.de, aber fügt noch leider etwas hintenan, so dass der Link nicht korrekt ist. * Als Version kann UMC und 1.8 ausgewählt werden. Schön wäre es die entsprechende UMC-Version anzuzeigen oder - noch besser - das entsprechende Univention-Release.
Bitte noch einen entsprechenden Bug anlegen, damit das umc-frontend-doc Paket zum Release noch einmal neu gebaut wird.
(In reply to comment #5) > Super, das funktioniert jetzt sehr gut! > > Changelog → OK > (Ich habe den einen Changelog-Eintrag bzgl. umc-frontend-src entfernt, da dies > nicht eine Änderung der internen Aufteilung ist.) > > Zu einem späteren Zeitpunkt kann auch das Theme angepasst werden (→ Bug 28843). > > Kleinigkeiten, die aufgefallen sind (→ Bug 28843): > * Der Feedback-Link verweist auf forge.univention.de, aber fügt noch leider > etwas hintenan, so dass der Link nicht korrekt ist. > * Als Version kann UMC und 1.8 ausgewählt werden. Schön wäre es die > entsprechende UMC-Version anzuzeigen oder - noch besser - das entsprechende > Univention-Release. BTW: "UMC" kann nicht ausgewählt werden, das sind noch Restbestandteile aus 3.0-2. Den Eintrag gibt es _mindestens_ nach einer Neuinstallation nicht mehr. (In reply to comment #6) > Bitte noch einen entsprechenden Bug anlegen, damit das umc-frontend-doc Paket > zum Release noch einmal neu gebaut wird. Bug #28844
OK
dgrid u.a. Libs wurden nach univention-dojo integriert, damit lässt sich derzeit das doc-Paket nicht bauen. Kannst du da bitte noch einmal nachschauen?
(In reply to comment #9) > dgrid u.a. Libs wurden nach univention-dojo integriert, damit lässt sich > derzeit das doc-Paket nicht bauen. Kannst du da bitte noch einmal nachschauen? fixed → univention-management-console-frontend-doc 6.0.6-1
Sieht prima aus!
UCS 3.1-0 has been released: http://forum.univention.de/viewtopic.php?f=54&t=2125 If this error occurs again, please use "Clone This Bug".