Automatische Entwicklerdokumentation.

Proggen.org - Lernprojekt: Duplikatefinder
Benutzeravatar
Xin
nur zu Besuch hier
Beiträge: 8489
Registriert: Fr Jul 04, 2008 11:10 pm
Wohnort: /home/xin
Kontaktdaten:

Automatische Entwicklerdokumentation.

Beitrag von Xin » Do Jul 01, 2010 11:13 pm

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.
Merke: Wer Ordnung hellt ist nicht zwangsläufig eine Leuchte.

Ich beantworte keine generellen Programmierfragen per PN oder Mail. Dafür ist das Forum da.

Benutzeravatar
cloidnerux
Moderator
Beiträge: 3084
Registriert: Fr Sep 26, 2008 4:37 pm
Wohnort: Ram (Gibts wirklich)

Re: Automatische Entwicklerdokumentation.

Beitrag von cloidnerux » Fr Jul 02, 2010 5:31 am

Gilt diese nur für trunk?
Und die falsch dargestellten Sonderzeichen sind auch nicht so hübsch.
Redundanz macht wiederholen unnötig.
quod erat expectandum

Benutzeravatar
Xin
nur zu Besuch hier
Beiträge: 8489
Registriert: Fr Jul 04, 2008 11:10 pm
Wohnort: /home/xin
Kontaktdaten:

Re: Automatische Entwicklerdokumentation.

Beitrag von Xin » Fr Jul 02, 2010 9:06 am

cloidnerux hat geschrieben:Gilt diese nur für trunk?
Yepp - und natürlich für Doxygen-Dokumentation.
cloidnerux hat geschrieben: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. ^^
Merke: Wer Ordnung hellt ist nicht zwangsläufig eine Leuchte.

Ich beantworte keine generellen Programmierfragen per PN oder Mail. Dafür ist das Forum da.

Benutzeravatar
Kerli
Beiträge: 1456
Registriert: So Jul 06, 2008 10:17 am
Wohnort: Österreich
Kontaktdaten:

Re: Automatische Entwicklerdokumentation.

Beitrag von Kerli » Do Jul 08, 2010 1:16 pm

Xin hat geschrieben: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 :P

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.
"Make it idiot-proof and someone will invent an even better idiot." (programmers wisdom)

OpenGL Tutorials und vieles mehr rund ums Programmieren: http://www.tomprogs.at

Benutzeravatar
Xin
nur zu Besuch hier
Beiträge: 8489
Registriert: Fr Jul 04, 2008 11:10 pm
Wohnort: /home/xin
Kontaktdaten:

Re: Automatische Entwicklerdokumentation.

Beitrag von Xin » Fr Jul 09, 2010 9:01 am

Steht nun in meiner Todo-Liste, kommt die Tage.
Merke: Wer Ordnung hellt ist nicht zwangsläufig eine Leuchte.

Ich beantworte keine generellen Programmierfragen per PN oder Mail. Dafür ist das Forum da.

Benutzeravatar
fat-lobyte
Beiträge: 1398
Registriert: Sa Jul 05, 2008 12:23 pm
Wohnort: ::1
Kontaktdaten:

Re: Automatische Entwicklerdokumentation.

Beitrag von fat-lobyte » So Aug 26, 2012 12:14 pm

Hallo.

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

1.
http://dedupe.proggen.org/srcdoc/html/index.html hat geschrieben: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.
Doxyfile hat geschrieben: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?
Haters gonna hate, potatoes gonna potate.

Benutzeravatar
fat-lobyte
Beiträge: 1398
Registriert: Sa Jul 05, 2008 12:23 pm
Wohnort: ::1
Kontaktdaten:

Re: Automatische Entwicklerdokumentation.

Beitrag von fat-lobyte » So Aug 26, 2012 5:37 pm

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
Haters gonna hate, potatoes gonna potate.

Benutzeravatar
Xin
nur zu Besuch hier
Beiträge: 8489
Registriert: Fr Jul 04, 2008 11:10 pm
Wohnort: /home/xin
Kontaktdaten:

Re: Automatische Entwicklerdokumentation.

Beitrag von Xin » Mo Aug 27, 2012 9:57 am

Hmm... da muss beim letzten Umzug was hops gegangen sein... kann ich für heute abend nicht versprechen, aber bekommt Prio.
Merke: Wer Ordnung hellt ist nicht zwangsläufig eine Leuchte.

Ich beantworte keine generellen Programmierfragen per PN oder Mail. Dafür ist das Forum da.

Benutzeravatar
Xin
nur zu Besuch hier
Beiträge: 8489
Registriert: Fr Jul 04, 2008 11:10 pm
Wohnort: /home/xin
Kontaktdaten:

Re: Automatische Entwicklerdokumentation.

Beitrag von Xin » Di Aug 28, 2012 11:28 pm

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

Die Test-Mail bitte ich zu entschuldigen.
Merke: Wer Ordnung hellt ist nicht zwangsläufig eine Leuchte.

Ich beantworte keine generellen Programmierfragen per PN oder Mail. Dafür ist das Forum da.

Benutzeravatar
fat-lobyte
Beiträge: 1398
Registriert: Sa Jul 05, 2008 12:23 pm
Wohnort: ::1
Kontaktdaten:

Re: Automatische Entwicklerdokumentation.

Beitrag von fat-lobyte » Di Aug 28, 2012 11:55 pm

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.
Haters gonna hate, potatoes gonna potate.

Antworten