Ich habe zwei C-Quelldateien. Ein Kommentar zu einer Funktion bar()
in Datei A
muss sich auf eine Funktion foo()
in Datei B
beziehen. Wie kann ich diesen Link erstellen?Link einfügen, um in einer anderen Datei mit Doxygen zu funktionieren?
Ich habe versucht:
Schreiben so etwas wie:
B.c::foo()
dass doxygen der Hoffnung gehen würde, umB
und findenfoo
dort Funktion Datei.Auch versucht einfach
::foo()
, aber das hat nicht geholfen.Dann habe ich versucht Datei
B.c
eine spezielle tagname wie dabei//! @file specialtag
auf erste ZeileB.c
geben und dannspecialtag::foo()
in meinem Kommentar zu tun, aber nicht viel geändert hat.Ich versuchte, die Verbindung mit
\ref
und\link
zu erzwingen, aber selbst das half nicht.
Die //! @file
Linie ist in beiden A.c
und B.c
so doxygen des Codes bewusst sein sollten.
EDIT
versuchte ich, was @doxygen vorgeschlagen, aber ohne Glück. Ich machte ein Beispielprojekt, um zu zeigen, wo ich in Probleme laufe, sein hier: http://www.filedropper.com/testdoxygen2tar
Ich benutzte die Standardeinstellungsdatei, die mit doxygen -g
gemacht wurde. Der Ausgang, den ich bekomme:
Sie können sehen, dass die Foobar-Funktion nicht verknüpft ist.
EDIT 2
das Problem gefunden. Die Funktion foo
war undokumentiert und daher wurde keine Seite generiert, also hatte doxygen natürlich keine Seite zum verlinken. (Ich erzeugte Dokumentation mit der aktivierten SOURCE_BROWSER
Option und hoffte, dass eine Verbindung zur Funktionsdefinition erzeugt würde)
Das Beste, was ich mir vorstellen kann, ist nur ein Link zu der Datei, mit einer FETTEN Notiz, die den Benutzer anweist, sich die Funktion anzuschauen, wenn sie da sind. Sie können eine automatische Verbindung herstellen oder @see verwenden.Tut mir leid, dass das nicht viel hilft. Ich würde gerne die Antwort selbst wissen. Wenn Sie hier kein Glück haben, vielleicht, um sich zu registrieren und Ihre Frage an die DoxyGen-Benutzer-Mailingliste zu senden? – Mawg