Automatische Entwicklerdokumentation.

[Xin]

Unter http://dedupe.proggen.org/srcdoc/html/index.html findet sich eine automatisch generierte Entwicklerdokumentation.

Bei jedem Checkin wird diese neu erstellt, das bedeutet, dass eure Dokumentation nach dem Checkin zügig im Netz dargestellt wird.

[cloidnerux]

Gilt diese nur für trunk?
Und die falsch dargestellten Sonderzeichen sind auch nicht so hübsch.

[Xin]

Gilt diese nur für trunk?

Yepp - und natürlich für Doxygen-Dokumentation.

Und die falsch dargestellten Sonderzeichen sind auch nicht so hübsch.

Das stimmt. Da muss ich gucken, ob und wie ich die noch hinbekomme oder - und das halte ich für nicht so unwahrscheinlich - dass man die Frage stellen muss, ob in Quellcodes Sonderzeichen dieser Art überhaupt verwendet werden sollten.

Trotzdem will ich auf Umlaute nicht unbedingt verzichten - da muss ich wohl nochmal ran. ^^

[Kerli]

Trotzdem will ich auf Umlaute nicht unbedingt verzichten - da muss ich wohl nochmal ran. ^^

Du solltest einfach auf eine neuere Version von Doxygen updaten. Da steht dann im HTML Head auch wirklich UTF-8 als Charset. Außerdem würden dann auch die ganze 'deprecated'-Warnungen verschwinden

Weiters wäre es auch gut wenn in der Konfiguration keine absoluten Pfade wären, da es doch etwas lästig ist wenn man das lokal anpassen muss.

[Xin]

Steht nun in meiner Todo-Liste, kommt die Tage.

[fat-lobyte]

Hallo.

Wie siehts eigentlich mit der Dokumentation aus?
Habe 2 Fragen:

1.

Generated on Sun Apr 15 2012 15:04:07 for Dedupe by

Nach dem 15. April gab es einige Commits, viele davon sehr relevant. Könntest du bitte die Doku neu generieren?

2.

OUTPUT_DIRECTORY = /www/proggenOrg/dedupe/srcdoc

Wieso das? Darf man nur auf dem Server die Doku generieren?

3. Es besteht die Möglichkeit, die Dokumentation aus dem Build-System heraus generieren zu lassen. Das mache ich bei einem anderen Projekt, und es funktioniert super:
Wenn Doxygen installiert ist, wird in den Makefiles ein "apidoc" Target angeboten. Dieses wird standardmäßig nicht gebaut.
Ruft man "make apidoc" auf, wird die Doku in das html/ Unterverzeichnis des Bauverzeichnisses gebaut.
Ist so etwas gewünscht?

Dazu muss das Doxyile zu "Doxyfile.in" werden, und einige Werte durch Platzhalter erstetzt werden. Ohne cmake kann dan die Doku nicht mehr erstellt werden.

ps.: 4. Ich habe gerade die Doku auf meinem System mit Doxygen 1.8 gebaut, und sie sieht um einiges toller aus. Gibts net möglichkeit upzugraden?

[fat-lobyte]

Achso.

Code: Alles auswählen

Warning: post-commit hook failed (exit code 127) with output:
/www/proggenOrg/svn/dedupe/hooks/post-commit: 51: /usr/share/subversion/hook-scripts/mailer/mailer.py: not found
/www/proggenOrg/svn/dedupe/hooks/post-commit: 52: /www/proggenOrg/createdoc.sh: not found

[Xin]

Hmm... da muss beim letzten Umzug was hops gegangen sein... kann ich für heute abend nicht versprechen, aber bekommt Prio.

[Xin]

Das Hook-Skript funktioniert nun wieder und auch die Mail funktioniert nun wieder.

Die Test-Mail bitte ich zu entschuldigen.

[fat-lobyte]

Danke!

Bleibt nur noch folgende Frage:

Es besteht die Möglichkeit, die Dokumentation aus dem Build-System heraus generieren zu lassen. Das mache ich bei einem anderen Projekt, und es funktioniert super:
Wenn Doxygen installiert ist, wird in den Makefiles ein "apidoc" Target angeboten. Dieses wird standardmäßig nicht gebaut.
Ruft man "make apidoc" auf, wird die Doku in das html/ Unterverzeichnis des Bauverzeichnisses gebaut.
Ist so etwas gewünscht?

Dazu muss das Doxyile zu "Doxyfile.in" werden, und einige Werte durch Platzhalter erstetzt werden. Ohne cmake kann dan die Doku nicht mehr erstellt werden.


Habe übrigens keine Testmail bekommen.