Automatische Entwicklerdokumentation.

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

Re: Automatische Entwicklerdokumentation.

Beitrag von Xin » Mi Aug 29, 2012 11:10 am

fat-lobyte hat geschrieben: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?
Klingt doch grundsätzlich gut.
fat-lobyte hat geschrieben: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.
Klingt grundsätzlich nicht so gut.

Was spricht dagegen, die aktuelle Doxygen-Konfig bestehen zu lassen und eine per CMake erzeugen zu lassen?
fat-lobyte hat geschrieben:Habe übrigens keine Testmail bekommen.
Da Du nicht im Commit-Verteiler stehst, würde mich das auch erschrecken, wenn Du eine Mail bekämst.
Wünschst Du mehr proggen.org-Spam? ;-)
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 » Mi Aug 29, 2012 11:26 am

Xin hat geschrieben:Was spricht dagegen, die aktuelle Doxygen-Konfig bestehen zu lassen und eine per CMake erzeugen zu lassen?
Technisch gesehen nichts, allerdings müsste man alle Änderungen an den Doxygen-Einstellungen zwei mal durchführen. Notwending finde ich das nicht, denn man könnte genausogut aus den Skripten machen, die die Doku bauen. Es ist deine Entscheidung, bitte bestimme wie du es haben willst.
Xin hat geschrieben:
fat-lobyte hat geschrieben:Habe übrigens keine Testmail bekommen.
Da Du nicht im Commit-Verteiler stehst, würde mich das auch erschrecken, wenn Du eine Mail bekämst.
Wünschst Du mehr proggen.org-Spam? ;-)
Nein, danke. Reicht schon :-)
Haters gonna hate, potatoes gonna potate.

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

Re: Automatische Entwicklerdokumentation.

Beitrag von Xin » Mi Aug 29, 2012 11:40 am

fat-lobyte hat geschrieben:
Xin hat geschrieben:Was spricht dagegen, die aktuelle Doxygen-Konfig bestehen zu lassen und eine per CMake erzeugen zu lassen?
Technisch gesehen nichts, allerdings müsste man alle Änderungen an den Doxygen-Einstellungen zwei mal durchführen. Notwending finde ich das nicht, denn man könnte genausogut aus den Skripten machen, die die Doku bauen. Es ist deine Entscheidung, bitte bestimme wie du es haben willst.
Dann muss ich das Skript ändern, dass die Doku auf dem Server baut.

Das ganze müsste also so ablaufen, dass ich den Pfad für die Dokumentation angeben kann.

Aktuell sieht das Skript so aus:

Code: Alles auswählen

#!/bin/bash

TOOL=$1

rm -rf /www/proggenOrg/$TOOL/export/trunk
svn export file:///www/proggenOrg/svn/$TOOL/trunk /www/proggenOrg/$TOOL/export/trunk
doxygen /www/proggenOrg/$TOOL/export/trunk/doc/Doxyfile
Man kann doxygen nicht extern ein Zielpfad vorgeben, zumindest weiß ich nicht wie. Man müsste die Doxygen-Config entsprechend bauen konnen.
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 » Mi Aug 29, 2012 7:08 pm

Sowas könnte man machen:

Code: Alles auswählen

#!/bin/bash

TOOL=dedupe
EXPORTDIR=/www/proggenOrg/$TOOL/export/trunk

rm -rf $EXPORTDIR
svn export file:///www/proggenOrg/svn/$TOOL/trunk $EXPORTDIR

mkdir $EXPORTDIR/builddoc
pushd $EXPORTDIR/builddoc

cmake $EXPORTDIR/doc
make apidoc

popd
Haters gonna hate, potatoes gonna potate.

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

Re: Automatische Entwicklerdokumentation.

Beitrag von Xin » Mi Aug 29, 2012 7:20 pm

fat-lobyte hat geschrieben:Sowas könnte man machen:

Code: Alles auswählen

pushd $EXPORTDIR/builddoc

popd
Ich bin - glaube ich kurz davor was zu lernen... man pushd gibt leider keinen Eintrag aus.
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 » Mi Aug 29, 2012 7:36 pm

Das ist ein builtin, also für Doku wäre das "man bash" und nach "pushd" suchen. So genau weiß ichs auch nicht, aber das ist in der Bash der einfachste Weg temporär in ein Verzeichnis zu gehen und danach wieder in das Ausgangsverzeichnis zurückzukehren. Anscheinend gibts so ne Art "Verzeichnisstack".
Haters gonna hate, potatoes gonna potate.

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

Re: Automatische Entwicklerdokumentation.

Beitrag von Xin » Mi Aug 29, 2012 8:39 pm

fat-lobyte hat geschrieben:Das ist ein builtin, also für Doku wäre das "man bash" und nach "pushd" suchen. So genau weiß ichs auch nicht, aber das ist in der Bash der einfachste Weg temporär in ein Verzeichnis zu gehen und danach wieder in das Ausgangsverzeichnis zurückzukehren. Anscheinend gibts so ne Art "Verzeichnisstack".
Hmm... sieht einfacher als bash und anschließendes cd aus... ^^
Wieder was gelernt. :-)
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.

Antworten