Seite 1 von 2
Automatische Entwicklerdokumentation.
Verfasst: Do Jul 01, 2010 11:13 pm
von 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.
Re: Automatische Entwicklerdokumentation.
Verfasst: Fr Jul 02, 2010 5:31 am
von cloidnerux
Gilt diese nur für trunk?
Und die falsch dargestellten Sonderzeichen sind auch nicht so hübsch.
Re: Automatische Entwicklerdokumentation.
Verfasst: Fr Jul 02, 2010 9:06 am
von Xin
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. ^^
Re: Automatische Entwicklerdokumentation.
Verfasst: Do Jul 08, 2010 1:16 pm
von Kerli
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
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.
Re: Automatische Entwicklerdokumentation.
Verfasst: Fr Jul 09, 2010 9:01 am
von Xin
Steht nun in meiner Todo-Liste, kommt die Tage.
Re: Automatische Entwicklerdokumentation.
Verfasst: So Aug 26, 2012 12:14 pm
von fat-lobyte
Hallo.
Wie siehts eigentlich mit der Dokumentation aus?
Habe 2 Fragen:
1.
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?
Re: Automatische Entwicklerdokumentation.
Verfasst: So Aug 26, 2012 5:37 pm
von 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
Re: Automatische Entwicklerdokumentation.
Verfasst: Mo Aug 27, 2012 9:57 am
von Xin
Hmm... da muss beim letzten Umzug was hops gegangen sein... kann ich für heute abend nicht versprechen, aber bekommt Prio.
Re: Automatische Entwicklerdokumentation.
Verfasst: Di Aug 28, 2012 11:28 pm
von Xin
Das Hook-Skript funktioniert nun wieder und auch die Mail funktioniert nun wieder.
Die Test-Mail bitte ich zu entschuldigen.
Re: Automatische Entwicklerdokumentation.
Verfasst: Di Aug 28, 2012 11:55 pm
von 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.