[Lada-commits] [PATCH 56 of 56] Hinweise zur Dokumentation eingefügt

[Wald Commits]

# HG changeset patch
# User Torsten Irländer <torsten.irlaender at intevation.de>
# Date 1376380323 -7200
# Node ID 7cddca668d218fdab67ac50d47dc4dcfcb66d523
# Parent  564ac7b313b252e94401405e777a5c8043feec9d
Hinweise zur Dokumentation eingefügt.

diff -r 564ac7b313b2 -r 7cddca668d21 Changes.txt
--- a/Changes.txt	Tue Aug 13 09:45:26 2013 +0200
+++ b/Changes.txt	Tue Aug 13 09:52:03 2013 +0200
@@ -1,6 +1,8 @@
 0.3
 ===
 
+ - Issue43: Dokumentation erweitert und für die Generierung der Dokumentation
+   mit Hilfe von JSDuck vorbereitet.
  - Issue39: Clientseitige Überprüfung der Datenfelder hinzugefügt: Nutzung von
    "numberfields" bei Zahlenwerten, maxLength, min/maxValue.
  - Issue51: Alle Datumsfelder haben nun die Möglichkeit auch eine Zeit mit
diff -r 564ac7b313b2 -r 7cddca668d21 README
--- 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.