2009-02-25 7 views
11

Gibt es eine Doxygen-Dokumentation der Boost-Bibliotheken irgendwo im Internet?Doxygen Dokumentation für die Boost-Bibliotheken?

Ich könnte meine eigene erstellen, aber ich denke, es sollte schon irgendwo im Web existieren? Vielen Dank!

+0

Ist der Boost (Graph) Bibliothek ein Doxyfile irgendwo in er hat? Dann könnten Sie die Dokumentation selbst erstellen. Wenn nicht, können Sie Doxywizard (GUI-Assistent) verwenden, um es für Sie zu generieren. In der Zwischenzeit können Sie auch versuchen, die [LXR-generierte Dokumentation] (http://acode-browser2.usatlas.bnl.gov/lxr-rel16/source/external/Boost_1.42.0_python2.6/boost-1_42/boost/) zu verwenden. graph /) – GuruM

+0

[Doxywizard howto] (http://www.stack.nl/~dimitri/doxygen/manual/doxywizard_usage.html) – GuruM

Antwort

0

Die definitive Boost-Dokumentation sind die Dokumente, die auf boost.org verfügbar sind. Sie neigen dazu, für die meisten Bibliotheken ziemlich gut zu sein.

Für welche spezifische Bibliothek reichen die Dokumente nicht aus?

+0

Die Boost-Dokumentation ist im Allgemeinen gut. Aber ich denke, die beste Quelle für Informationen ist eigentlich der Code selbst, und das ist am besten durch doxygen-generierten HTML-Code (ich suche speziell nach dem Boost-Graph-Code). – Frank

+0

Boost.Graph hat eigentlich sein eigenes Buch. Ich denke, das ist der definitive Leitfaden für die Boost.Graph-Bibliothek. Ich kenne keine Doxygen-Dokumentation für Boost. – user21714

0

Die Boost-Bibliotheken haben ziemlich viel Template-Code und Präprozessor-Makros. Doxygen versteht Vorlagen oder Makros nicht sehr gut. Ich würde mich an die Standard-Boost-Dokumentation halten.

+0

Warten Sie, die STL hat viel Vorlagencode und sie haben öffentliche Doxygen-Dokumentation, die mir gut aussieht. Warum würde Doxygen den Boost-Code nicht verstehen? – Frank

+0

Werfen Sie einen Blick auf boost :: function oder boost :: bind. STL verwendet keine Vorlagen wie diese. Wenn sich Doxygen vor einem Jahr nicht wesentlich verbessert hat, bin ich nicht auf einige der Boost-Bibliotheken angewiesen. – Ted

0

Obwohl nicht auf Doxygen basierend, können Sie die folgende Seite nützlich finden. Boost Graph Bibliothek (v1.42) online durchsuchbaren LXR Quellcode verfügbar here. Sie können von der Definition zur Verwendung springen und umgekehrt. Um andere Boost-Komponenten wie bind, type_traits usw. zu durchsuchen, navigieren Sie einfach die main site

+0

Korrigierte URL behoben – GuruM

2

Es gibt ein paar Sätze der Dokumentation.

Die Dokumentation zur aktuellen Version von boost finden Sie unter im Internet unter dem untenstehenden Link (mit bestimmten, älteren Versionen auf der rechten Seite verlinkt).

http://www.boost.org/doc/libs/

Wenn Sie nach einer herunterladbare Version der HTML-Dokumentation sind, dann ist es auch in der Boost-Distribution enthalten ist, die Sie von der Website herunterladen. Öffnen Sie die Datei index.html im Verzeichnis libs in Ihrem bevorzugten Browser.

Persönlich würde ich ganz gerne eine CHM-Datei von der ganzen Partie, aber es scheint, dass diese mit Doxygen und hhc.exe auf Windows (die ich nicht verwenden muss) manuell erzeugt werden (Boost nicht zur Verfügung stellen), Wir würden uns über alle Informationen freuen, die Sie erhalten, wenn Sie aktualisierte CHMs mit Boost-Dokumentation erhalten möchten.