Mercurial > lada > lada-client
diff README @ 340:7cddca668d21
Hinweise zur Dokumentation eingefügt.
author | Torsten Irländer <torsten.irlaender@intevation.de> |
---|---|
date | Tue, 13 Aug 2013 09:52:03 +0200 |
parents | e02d07abc4fe |
children | d0a9a1c31441 |
line wrap: on
line diff
--- a/README Tue Aug 13 09:45:26 2013 +0200 +++ b/README Tue Aug 13 09:52:03 2013 +0200 @@ -12,3 +12,14 @@ curl -O http://cdn.sencha.com/ext/gpl/ext-4.2.0-gpl.zip unzip ext-4.2.0-gpl.zip ln -s ext-4.2.0-gpl extjs + +Dokumentation +============= +Die Dokumentation wird mit dem Tool JSDuck erzeugt. +Im Wurzelordner lässt sich nach der Installation von JSDuck dann mit dem +Befehl "jsduck" die Dokumentation für den Lada-Clienten erzeugen. +Die Dokumentation findet sich nach der Generierung in dem Order "doc". +Einstiegseite ist die Seite template.html. + +Einstellung bezüglich der Generierung der Dokumentation ist in der Datei +jsduck.json hinterlegt.