Doxygen Dokumentation LaTeX
-
Ich wollte damit sagen, dass man die Doku doch gerade schreibt, damit der Benutzer nicht mehr im Header nachgucken braucht, wie die Schnittstelle aussieht, sondern dies bequem in der Doku tun kann.
-
SeppJ schrieb:
Ich wollte damit sagen, dass man die Doku doch gerade schreibt, damit der Benutzer nicht mehr im Header nachgucken braucht, wie die Schnittstelle aussieht, sondern dies bequem in der Doku tun kann.
Okay, das stimmt natürlich. Wobei ich dennoch den Headerstil vorziehe, weil manches über die Doku, manches über den vorliegenden Code schneller ist (und bei uns Doxygen nachts läuft, zwischenzeitliche Änderungen daher nur über den Code ermittelbar sind).
-
also, ich dokumentiere ausschließlich im header und auch nicht zwei mal.
Allerdings würde ich die Doku auch gerne im Header belassen, daich das übersichtlicher finde.
Die doppelten Einträge kommen auch nur in der PDF-Version der Doku. Die Einstellungen, die im verlinkten Forenbeitrag vorgeschlagen sind habe ich bereits alle so und den Tipp, die .c-files nicht mit @file zu versehen habe ich gerade getestet, allerdings fehlen mir dann die call(er) graphs der Funktionen... ich glaube langsam dass da irgendwas bei doxygen falsch läuft...Vielen Dank für die Tipps so weit
-
Merke: Computer machen selten von sich aus etwas falsch. So langsam wäre es wohl das beste, wenn du versuchst, einfach ein Minimalbeispiel zu basteln. KAnnst du den gleichen Effekt mit einem fast leeren Header und einer fast leeren Sourcedatei hinbekommen? Wenn ja, dann poste sie hier und das zugehörige Doxyfile auf irgendeinem pastebin. Eventuell auch noch das produzierte pdf, wenn du es irgendwo hochladen kannst.
-
m0w1337 schrieb:
Die Einstellungen, die im verlinkten Forenbeitrag vorgeschlagen sind habe ich bereits alle so und den Tipp, die .c-files nicht mit @file zu versehen habe ich gerade getestet, allerdings fehlen mir dann die call(er) graphs der Funktionen... ich glaube langsam dass da irgendwas bei doxygen falsch läuft...
Mich wundert das irgendwie, bei unseren doxygen-Dokumentationen ist der Caller-Graph auch enthalten, und fast alle Dokumentation befindet sich im Header (außer bei alten Code, bei dem in den letzten Jahren noch keine Änderung von mir erfolgt ist [Ich räume beim Anpassen in der Regel gleich auf]).
-
Okay also hier die kurzform. Die Funktion Bit_sort wird zwei mal dokumentiert in der PDF einmal in der Section der .h-file und einmal in der der .c-file.
Vielen Dank für eure Geduld
Moritz
-
Das meintest du die ganze Zeit?
Das ist doch klar, dass in der Doku zu den beiden verschiedenen Dateien beide Mal die Funktion dokumentiert ist, schließlich steht sie ja auch in beiden Dateien. Ist das denn nicht das gewünschte Verhalten? Wie wünscht du dir in diesem Fall denn stattdessen die Darstellung? Oder provokanter gefragt: Für welche der beiden Dateien soll die Dokumentation lügen?Die einfachste Abhilfe wäre schon genannt: Dokumentation nur an einer Stelle. Es mag noch einen weitere Möglichkeiten geben, aber so würde ich es machen.
-
Dokumentation nur an einer stelle.... ja wo habe ich die Funktion denn an zwei stellen dokumentiert? und die Doku muss nicht lügen, schliesslich stehen in der c-file keinerlei Informationen über die Funktion, mir ist klar, dass die Funktion gelistet wird, aber wieso mit sämtlichen Infos aus der h-file? Für mich macht es keinen Sinn exakt dieselben Informationen zwei mal auszudrucken, es wäre viel logischer, wenn in der c-file ein Verweis zur ausführlichen Dokumentation der Funktion auf die h-file steht.
-
m0w1337 schrieb:
Dokumentation nur an einer stelle.... ja wo habe ich die Funktion denn an zwei stellen dokumentiert?
Oh, so genau hatte ich mir den Code gar nicht angesehen, sondern nur das Resultat, da ich an dem Rechner an dem ich gerade sitze sowieso kein doxygen installiert habe. Wenn ich wieder an meinem Hauptrechner bin gucke ich mir das mal genauer an, denn so sollte es wirklich nicht sein. Kann aber eine Weile dauern, bis ich dazu komme.
-
Hallo zusammen!
Gibt es mittlerweile einen Verdacht, wo mein Fehler liegt? Ich wäre euch wirklich dankbar, ich komme einfach nicht drauf....
Grüße
Moritz
