Wie kann ich die Verbindung zwischen markdown-Dokumente in doxygen?

Habe ich ein Projekt mit einer Reihe von markdown-Seiten, die miteinander verbunden sind, mit links wie

[Go to this page](subdir/MyOtherPage.md)

Den Seiten alle abgeholt, die von doxygen und in der Ausgabe angezeigt, aber die links werden nicht verändert und zeigen Sie Ihre neue html-Darstellungen.

Ändern könnte ich die links verweisen auf die html-Seiten, aber mein Projekt ist gehostet auf github und dann solche links werden würde, gebrochen, da github unterstützt die Verknüpfung zwischen markdown-Seiten automatisch.

Ich kann nichts sehen in der doxygen-Dokumentation über die Unterstützung von links, die andere als externe sind. Gibt es eine Möglichkeit, um doxygen erzeugt eine HTML-link aus einer markdown ein?

  • Hat die doxygen-Befehl \ref überhaupt helfen? Es funktioniert für mich für die Verlinkung zu doxygen \section Header in den anderen markdown-Seiten, aber ich bin mir nicht sicher, ob das hilft, Ihre spezifischen Anforderungen neu github.
InformationsquelleAutor izb | 2013-10-09
  1. 15

    Als pro Doxygen 1.8.7 gibt es drei Möglichkeiten, dies zu tun:

    • Verwenden Sie ein standard-markdown-hyperlink, wie beschrieben, in Ihrer ursprünglichen Frage.
    • Verwenden @ref Präfix und das Ziel mit md_ zusammen mit allen Unterverzeichnissen.
    • Namen der Seite und verwenden Sie @ref bis auf den Namen beziehen.

    Die erste Methode ist unkompliziert und es wird auch funktionieren, ohne Doxygen (z.B. beim durchsuchen von code-repository auf Github).

    [Go to this page](subdir/MyOtherPage.md)

    In der Erwägung, dass die zweite Methode verknüpfen Sie es so:

    [Go to this page](@ref md_subdir_MyOtherPage)

    Offenbar auch dies ist die Art und Weise vorgeschrieben durch die Doxygen primäre Autor.

    Schließlich in der Dritten Methode müssen Sie einen Namen für die Ziel-Seite und dann eine Verknüpfung zu diesem Namen. Beispiel:

    In MyOtherPage.md die header

    # My Other Page Title {#MyOtherPageName}

    dann verknüpfen Sie Sie es wie so

    [Go to this page](@ref MyOtherPageName)
    • Beachten Sie, dass doxygen 1.8.7 ist wichtig, Centos 7 kommt immer noch mit 1.8.5, wo die Dritte option wird nicht funktionieren. Es wurde nur über drei Jahre, besser halten doxygen stabil.
    InformationsquelleAutor adib
  2. 4

    Regelmäßige alte Markdown-links werden so gehandhabt, wie von Doxygen 1.8.6, z.B. [link text](docs/page.md). Dies funktioniert ein wenig wackelig, obwohl-die URL muss relativ aus der Doxygen-Arbeitsverzeichnis (also nicht das Verzeichnis der Doxyfile oder die .md-Datei, sondern das Verzeichnis, aus dem Doxygen AUSGEFÜHRT wird). Wenn Sie bemerken, dass ein Klick auf den link zeigt rohe Markdown anstatt HTML gerendert, es bedeutet, dass Ihre URL nicht relativ vom Arbeitsverzeichnis für Doxygen.

    • Diese behoben das problem für mich in meinem Fall habe ich den Ordner doc mit doxyfile und markdown-Ordner. Deshalb habe ich zu schreiben [file](markdown/file.md). Danke!!!
    • Wenn ich mich nicht Irre, versucht zu Referenz [einige](link/zur/Datei.md) von einem anderen .md-Datei, die nicht relativ zu denen Doxygen ausgeführt wird, bricht alles für Gitlab (aber nicht für Doxygen). So dies ist grundsätzlich unvereinbar mit den gleichen links für md-Dateien in ein repo sichtbar und in Doxygen zur gleichen Zeit.
    InformationsquelleAutor Kyle
  3. 2

    Dieses feature wurde Hinzugefügt, in Doxygen 1.8.6 (Dez 2013)

    Allow @ref to unlabeled markdown page by name, i.e. @ref mypage.md
Allow links to other markdown pages of the form [link text](page.md)

    Müssen Sie möglicherweise incldue in der Dokumentation Verzeichnis, in dem link für ihn zu arbeiten, z.B.

    [link text](docs/page.md)
    • Ich benutze 1.8.7, und es funktioniert immer noch nicht. Es bezieht sich immer auf die Quelle der .md-Datei (in html), nicht gerendert (html) - Seite. es spielt keine Rolle, ob ich @ref oder [here](documentation.md). Gibt es dafür eine Lösung?
    • Nicht für mich arbeiten, entweder, auf 1.8.6...
    • Funktioniert nicht in 1.8.11 sowie
    • Habe es in 1.8.11. Mögliche Fallstricke: die verlinkte Seite muss enthalten sein in-EINGANG, und die verlinkte Seite darf nicht enthalten einen header label (z.B. # Page {#page})
    InformationsquelleAutor rockgecko
  4. 0

    Können die folgenden Schritte das problem lösen,

    • set STRIP_FROM_PATH zu Doxyfile-Verzeichnis. Es gibt ein problem mit relativen Pfad, während die Verknüpfung der markdown-Dateien.

    • fügen Sie den folgenden code in die doxygen-source-Datei src/docparser.cpp bei 2438 Zeilennummer mit code pd = Doxygen::pageSDict->find(target); (wenn es nicht bereits vorhanden). Es behebt die markdown-Datei suchen in der Seite-Liste.

      if(pd == 0 && lang == SrcLangExt_Markdown) {pd = Doxygen::pageSDict->finden(markdownFileNameToId(target));}

    • Endlich eine Zusammenstellung der doxygen und versuchen Sie es erneut.

    Es funktionierte für mich.

    InformationsquelleAutor shuva
Schreibe einen Kommentar