2015-10-02 16 views
14

Ich verwende Zeal, um API-Dokumentation unter Linux zu suchen. Es erfordert Dateien im Apple docset Format.Wie mache ich docset unter Linux?

Ich habe C++ Code, für den ich Dokumentation unter Verwendung Doxygen erzeugen kann. Doxygen kann ein Docset erstellen, benötigt aber das Programm docsetutil, das unter Linux nicht verfügbar ist.

Gibt es eine andere Methode, um ein Docset einer C++ - Codebasis unter Linux zu erstellen?

Antwort

4

"No need for docsetutil if you're generating a Dash-only docset," schlägt den Entwickler von Dash vor. Ebenso according to the Dash documentation, müssen Sie die folgenden Einträge in der Konfigurationsdatei Doxygen die Bird Dokumentation (die letzten 3 sind optional) zu erzeugen:

GENERATE_DOCSET = YES 
DISABLE_INDEX  = YES 
SEARCHENGINE  = NO 
GENERATE_TREEVIEW = NO 
+0

Ich bin ein wenig verlegen ich das nicht selbst das finden! Danke, dass du die Beinarbeit gemacht hast und darauf hingewiesen hast - löst mein Problem auf eine andere (und einfachere Weise!) Weise, als ich erwartet hatte. – cincodenada

+2

Falls andere sich fragen: Sie müssen doxygen mit der richtigen Konfiguration ausführen, führen Sie make im HTML-Ordner aus. Make wird scheitern, wird aber genug arbeiten. Die Docset befinden sich als Unterordner im HTML-Ordner namens etwas wie * .docset – olejorgenb

+1

Ich habe dies versucht, um ein docset für SDL 2.0.4 zu generieren, zunächst Doxygen und MSYS unter Windows, dann wiederholen Sie es auf Linux Mint. Beide Male, wie erwartet, das Makefile fehlgeschlagen, die Forderung docsetutil wird nicht gefunden. Aber beide Male waren die generierten Dateien * NICHT * ausreichend - mit dem docset-Ordner, in dem Zeal nach ihnen sucht, keine Spur der Dokumente in Zeal. Ich habe versucht, eine meta.json-Datei zu fälschen, da diese nicht generiert wurde - hat nicht geholfen, und das und einige Symbole fehlen auch im mono-docset, das funktioniert. Next suspect - docSet.dsidx - Jedes Docset, das ich habe, hat das, aber es wird nicht für SDL generiert. – Steve314