Tag: doxygen
Doxygen ist eine Mehrsprachige Generierung von Dokumentation Anwendung für C++, C, Java, Objective-C, Python, IDL, Fortran, VHDL, PHP und C# unterstützt eine Vielzahl von Ausgabe-Formaten, einschließlich RTF -, HTML -, XML-und PDF-Format.
Gewusst wie: einfügen von multi-line-Kommentar in Doxygen code-Beispiele
1 Antworten
Ich versuche gehören ein code-Beispiel enthält einen mehrzeiligen Kommentar in der Doxygen-Dokumentation. Das problem ist, dass der C++ - Präprozessor interpretiert die */ als das Ende meiner Doxygen-Kommentar und daher ist die syntax der Datei ist kaputt.
Wie Doxygen Methode Beschreibung in Xcode die autocomplete popup?
3 Antworten
Verwendung von Xcode , möchte ich die Doxygen-Beschreibung meiner Methode unter der AutoVervollständigen-option, wie alloc: Beim schreiben, Xcode zeigt die AutoVervollständigen mit den Kommentaren aus der Dokumentation. Sie können im Bild sehen Sie zum Beispiel, wenn alloc
Was ist der Mathworks Weg zur Generierung von Matlab in der HTML-Dokumentation?
3 Antworten
Bin ich arbeiten auf gemeinsam genutzten Matlab-code, und wir möchten, zu teilen einer generierten Dokumentation als durchsuchbare HTML-Dokumente in unserem lokalen Netzwerk. Ich kenne die folgenden Methoden zum generieren einer Dokumentation: Schreiben Sie ein Programm, um C++-Dateien
Doxygen und Graphviz auf Lion
3 Antworten
Habe ich erfolgreich installiert Doxygen und GraphViz auf meinem mac (Lion, OS), aber wenn ich die doxygen-mit graphViz bekomme ich folgende Fehlermeldungen: 1) sh: dot: command not found 2) Problems running dot: exit code=127, command='dot', arguments='"/Users/../xxx.dot" -Tpdf
Eigene "interne" von "externen" Dokumentation in doxygen
3 Antworten
Möchte ich ein Dokument Bibliothek mit doxygen. Die Dokumentation wird gelesen von den zwei Klassen von Menschen: die Benutzer, die sind nur daran interessiert, die externe API und Entwickler, die möchten, finden Sie in der Dokumentation für
Wie man doxygen Präprozessor, Rekursion in Unterverzeichnisse?
1 Antworten
Ich nicht bekommen, die doxygen Präprozessor rekursiv include-Dateien. Wie Sie dies tun? Ich aus einem Beispiel, bestehend aus zwei Kopf-und eine Doxygen-Datei: subdir/example.h subdir2/example_include.h Doxygen Dies ist die Liste der example.h: #include "example_include.h" typedef struct { float
Doxygen: Dokumentation überladene Funktionen
2 Antworten
Fall, ich habe mir die Dokumentation getrennt von meinem code, wie kann ich helfen, Doxygen unterscheiden zwischen überladenen Funktionen (was in der \fn Bereich)? Eine einzelne Funktion wäre dokumentiert wie dieses: void func() { } /** \fn
Doxygen ist nicht die Generierung von Dokumentation für Quelldateien
2 Antworten
Ersten mal mit Doxygen hier. Mit dem Doxygen-Assistenten, und ich bin mir ziemlich sicher, dass ich das einstellen der Verzeichnisse und alles korrekt, aber für einige Grund der ausgegebenen Dokumentation hat nur die header-Dateien. Mein Projekt ist
In der doxygen-Dokumentation so erstellen Sie eine Verknüpfung zu einer bestimmten Zeile einer Datei
1 Antworten
Gibt es mehrere doxygen-Befehle, deren Zweck es ist, um links zu erstellen, die in der Dokumentation (@link, @ref). Ich bin derzeit mit dem @ref Befehl erstellen Sie einen link zu einer benutzerdefinierten Datei, geschrieben in einer Sprache,
Wie Makros erweitert von doxygen, aber nicht dokumentiert wie eine definieren?
1 Antworten
Sagen, ich habe: #define MY_MACRO(FOO) void FOO(); MY_MACRO(hi); MY_MACRO(hey); MY_MACRO(hello); #undef MY_MACRO Möchte ich die Makros werden erweitert, die von doxygen, die ich in der Lage bin zu tun, indem Sie konfigurieren, dass Sie die richtige Art
Erstellen Sie eine "Schnelle Hilfe" - Eintrag in Xcode
7 Antworten
Wie erstelle ich schnelle Hilfe Einträge in Xcode für meinen eigenen code? Ich will ihn so ein coding-Unterstützung, was bedeutet, wie der Eclipse-Funktionalität beim Programmieren in Java. In eclipse bekommen Sie einen Kommentar von Ihnen oben angegebenen
Tun Doxygen-config-Dateien-Unterstützung von Variablen?
2 Antworten
Zum Beispiel habe ich den source-code-Pfad als c:\code\testapp\src. Ist dies dann als eine var, die ich nutzen kann - zum Beispiel, so kann ich spuckte eine tag-Datei in eine Lage relativ zu diesem, nicht in Bezug auf
Wie, um Kommentare hinzufügen zu fenced code Blocks innerhalb von doxygen Dokumentation
2 Antworten
Ich bin mit fenced code blocks in Doxygen mit Hilfe der markdown-syntax. Dies macht es einfach, ein einfaches code-Beispiel, wie diese: ~~~~~{.cpp} void doSomething() { } ~~~~~ Wenn ich versuche, Kommentare hinzufügen in den eingezäunten code-block mit
Gibt es eine @inheritDoc entspricht in Doxygen?
2 Antworten
Ich weiß Javadoc erstellen {@inheritDoc}, aber was ist der Doxygen Weg, dies zu tun? InformationsquelleAutor Roberto | 2011-04-04
Emacs + C/C++ + Doxygen: Alternative zu doxymacs? Mit yasnippet?
2 Antworten
Möchte ich nutzen, doxygen generieren, code-Dokumentation (Funktionen) in .c oder .cc Dateien mit Emacs. Ich fand doxymacs, aber es scheint nicht mehr gepflegt (Letzte version 2007) und ich habe auch nicht einen Weg finden, zu aktualisieren, die
Generieren von Dokumentation als markdown-Dateien mit doxygen
3 Antworten
Ich weiß, dass es möglich ist, mit markdown-innen Kommentare und doxygen kann es verstehen. Aber ich muss wissen, ob es möglich ist, zum generieren der Dokumentation im markdown-format? Ich brauche diese Dokumentation aus C++ - Dateien. Ich
doxygen-syntax in python
2 Antworten
Kann jemand bitte helfen Sie mir, um herauszufinden, wie Kommentar python-code richtig zu bekommen, analysiert von doxygen? Irgendwie ignoriert die tags. Die Ausgabe (HTML) und zeigt die tags: @brief Creates a new Hello object. This Hello Object
Mithilfe von doxygen zur Erstellung der Dokumentation für die bestehenden C# - code mit XML-Kommentaren
1 Antworten
Habe ich gelesen überall, dass doxygen ist der Weg zu gehen für die Generierung von Dokumentation für C# - code. Ich habe eine einzige Schnittstelle, die ich dokumentieren wollen ersten (baby -) Schritte, und es hat bereits
Wie soll ich klassifizieren ein "typedef" mit Doxygen?
2 Antworten
Habe ich typedef structs in meinem C++ - code. Wie von Recht nun Sie aufgeführt sind, als \var typedef. Gibt es einen besseren Weg, dies zu tun? Unten ist ein Beispiel von dem, was ich habe: /*!
Ändern Sie das Thema Doxygen?
2 Antworten
Ich denke nicht wirklich, dass die Doxygen-HTML-Thema für die Dokumentation von C-code ist gut für die Dokumentation von Funktionen und Prozeduren (obwohl es genial ist für die Dokumentation von OOP, wenn mit C++). Also was ich verlange
Wie kann ich die Verbindung zwischen markdown-Dokumente in doxygen?
4 Antworten
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
Wie kann ich doxygen Dokumentation von #defines in eine C-Datei?
7 Antworten
Habe ich #define Werte im Header, ich will unbedingt Doxygen zu dokumentieren, aber ich habe andere in C Dateien, die ich behandeln, als statische Konstanten, und ich will nicht Doxygen zu dokumentieren. Etwas, das so einfach und
Link einfügen Funktion in einer anderen Datei mit Doxygen?
1 Antworten
Ich habe zwei C-Quelldateien. Ein Kommentar zu einer Funktion bar()im Datei - A Bedürfnisse zu finden, um eine Funktion foo() im Datei -B. Wie kann ich diese verknüpfen? Habe ich versucht: Etwas zu schreiben wie: B.c::foo() in
Dokumentieren-Variablen mit Doxygen in C
2 Antworten
Code: #include <stdio.h> /* * \var int iOne * \brief Integer 1 */ /* * \var int iTwo * \brief Integer 2 */ /* * \var int iThree * \brief Integer 3 */ /** * \brief Imitates
Wie erstellen Sie einen Zeilenumbruch in Doxygen markdown?
2 Antworten
Ich habe eine harte Zeit Auffinden der Dokumentation welche erklären, wie Sie einen Zeilenumbruch in Doxygen markdown. Ich habe versucht, mit zwei Leerzeichen am Ende der Zeile, und ich habe auch versucht einen einzelnen oder doppelten Zeilenumbruch,
Controlling Doxygen die LaTeX-Ausgabe für die Herstellung der PDF-Dokumentation
3 Antworten
Ich bin mit Doxygen-Dokumentation generiert werden für meinen code. Ich brauche, um eine PDF-version dieses und die Benutzung von Doxygen der LaTeX-Ausgabe angezeigt wird, werden die Art und Weise, es zu tun. Aber ich habe laufen in
Doxygen ist Langsam
1 Antworten
Doxygen dauert etwa 12 Stunden für unsere code-Basis. Dies ist vor allem, weil es ist eine Menge code zu verarbeiten (~1.5 M-Linien). Aber, es ist sehr schnell nähert sich der Punkt, an dem wir nicht können nächtliche
Dokumentieren, C++/CLI-code-Bibliothek für die Verwendung von c# - besten-tools und-Praktiken?
5 Antworten
Arbeite ich an einem Projekt, wo ein c++/cli-Bibliothek verwendet wird in Erster Linie von einer c# - Anwendung. Gibt es eine Möglichkeit, um die code-Kommentare in c++/cli sichtbar zu c# intellisence innerhalb von visual studio? Vorausgesetzt, es
Generieren Sie Diagramme und Diagramme mit Doxygen
1 Antworten
Brauche ich zum generieren von Klassendiagrammen oder ein graph einer C++ - Projekt mit Doxygen, installierte ich es auf Ubntu 12.04 wie folgt: sudo apt-get install doxygen sudo apt-get install doxygen-gui nun weiß ich nicht, wie das
Kann ich mein Github-Seiten index.html in einem Unterordner des repository?
6 Antworten
Ich versuche, Github pages hosten einer Doxygen-Website. Im Idealfall würde ich mag in der Lage sein drücken Sie die generierten Dateien und Verzeichnisse auf Github, ohne zu zwicken Sie überhaupt nicht. Das bedeutet jedoch, dass mein index.html
Dokumentation Python-Pakete mit doxygen
1 Antworten
"Spezielle Dokumentations-Blöcke in Python" in http://www.doxygen.nl/manual/docblocks.html gibt ein Beispiel der doxygen-Nutzung mit Python. In die entsprechende HTML-Dokumentation, die von doxygen erzeugten (Beispiel für die Ausgabe im web), wenn man Klicks auf einen package-Namen, dann werden alle Beschreibungen,
Wie veröffentlichen auf Github-Seiten aus Travis CI?
5 Antworten
Sind wir kompilieren die Doxygen-Dokumentation über die travis-ci-server und wollen, drücken Sie diese auf unserer gh-pages-branch. Wie umgehe ich die Berechtigung für git push? Hat jemand ein Beispiel für die Verwendung von verschlüsselten Variablen in travis-ci? Sollte
Doxygen - Dokument eine struct-variable, aber nicht die Struktur
3 Antworten
Lassen Sie uns sagen, dass ich diese struct-Typ: typedef struct Hidden Hidden; struct Hidden { int foo; int bar; }; und dann habe ich eine Globale variable Hidden visible; Hidden sollte niemals verwendet werden, und visible sollte
So erzeugen Sie CHM mit Doxygen-und HTML-Hilfe-Compiler?
3 Antworten
Die kurze Geschichte: ich generieren können eine CHM-Datei mit Doxygen. Starten Sie die CHM-Datei, die ich beobachten, dass den Inhalt und Index-Registerkarten-do-Liste der Seiten, namespaces, - Klassen, und die Mitglieder dieser Klassen. Allerdings, indem Sie auf die
Doxygen-Gruppen und Module index
1 Antworten
Erstelle ich ein Doxygen Dokument für mein Projekt. Vor kurzem habe ich gruppiert Verwandte Klassen mit \addtogroup tag. Nach diesem, ich habe eine Modul-Registerkarte in meine Dokumentation. Es zeigt alle Module. Ich möchte hinzufügen, dass einige Beschreibung
Dokumentieren Enumerationen, die mit doxygen
3 Antworten
Den html-Dokumentation erzeugt von doxygen für enums enum listet die Links und die Dokumentation auf der rechten Seite. Jedoch brauche ich sehr detaillierte Dokumentation für jeden Wert, und einige der Namen sind sehr lang, so dass die
Wie bekomme ich Doxygen, "link" enum-Definitionen?
1 Antworten
Ich habe den folgenden code: ///\file Doxygen_tests.h /** * * \enum Tick_Column_Type * * \brief Values that represent Tick_Column_Type. **/ enum Tick_Column_Type { TC_OPEN, ///< Opening price TC_HIGH, ///< High price TC_MAX, ///< Required as last enum
Doxygen: das einbetten von Bildern auf die Haupt-Seite für alle Ausgabe-Formate?
1 Antworten
Ich bin mit Doxygen 1.8.6 auf Ubuntu 14.04 zu generieren API-Dokumentation von C/C++ - header-Dateien. Ich habe eine Hauptseite im markdown-format (Datei mainpage.md) und einbetten möchten Sie ein Bild (Datei logo.png) in die Seite. Derzeit habe ich,
Dokumentation erscheinen nicht in doxygen-Ausgabe
1 Antworten
Ich versuche zu dokumentieren, eine C-API, die alle in einer einzigen C-Header-Datei. Wenn ich doxygen, auf die Datei, es ist mir Fehler für die derzeit ohne Papiere C-Makros, aber wenn ich die notwendigen Unterlagen für Makros, obwohl
Referenz einer bestimmten Klasse, Methode mit @siehe Befehl mittels Doxygen
2 Antworten
War ich nicht in der Lage, auf eine konkrete Klasse Methode unter Verwendung der doxygen @siehe Befehl. Angenommen ich habe eine Klasse Server mit einer Methode starten, wie unten @interface Server : NSObject - (void) start:(NSInteger) mask;
Verwendung von @oder sehen @link in doxygen
3 Antworten
Ich dokumentieren mit Javadoc vor und verwendet die tags @see, @link oder {@see foo} und {link foo} in meiner Beschreibung, link zu anderen Klassen. Jetzt habe ich versucht doxygen-und es scheint, dass diese tags nicht kompatibel sind.
Dokumentation der Qt-Dokumentation Kommentare? Qt + Doxygen?
4 Antworten
Wo finde ich Unterlagen für die Qt-Dokumentation Kommentare? Ich beziehe mich auf wie Qt verwendet einen speziellen Stil für die Dokumentation Kommentare, etwa so: /*! \class MyClassName \brief The MyClassName class is used as an example on
Kostenloses UML-tool mit c++ code-Generierung und die doxygen-Unterstützung
3 Antworten
Ich weiß features wie code-Generierung und die doxygen-Unterstützung sind in der Regel als kommerziell, aber ich Frage mich, ob es irgendwelche kostenlosen UML-tools zur Unterstützung von c++ - code-Generierung unterstützt doxygen-Dokumentation? Wäre es sehr nützlich, um zu
Doxygen nicht dokumentieren main-Funktion in main.cpp
4 Antworten
Habe ich eine main.cpp enthält eine Struktur, die einige Globale Konstanten und eine main-Funktion. Lief ich doxygen und die Dokumentation nur ich bin immer in der Ausgabe index.html ist für meine struct. Möchte ich doxygen zu dokumentieren,
Die Verwendung von doxygen zu dokumentieren, die Mitglieder der c-Struktur außerhalb der Struktur-definition
1 Antworten
Ich bin mit doxygen-Kommentar zu mein C-code. Ich bin unter Verwendung einer fremden API (also nicht meine eigene) für die Dokumentation ist knapp, also habe ich die Absicht Dokument einige, die API in meinem eigenen source-Dateien. Ich
Relative Pfade der Dateien in die doxygen-generierte Dokumentation
1 Antworten
Ich bin mit Doxygen 1.7.4 für Windows. In der Datei Liste Seite der generierten Dokumentation ich möchte sehen, wie relative Pfade. Ich habe FULL_PATH_NAMES = YES, um noch etwas mehr, als nur den Dateinamen ohne Pfad, aber
So installieren Sie die Doxygen-GUI auf Ubuntu?
5 Antworten
Ich kann nicht herausfinden, wie zu installieren, die Doxygen-GUI (doxywizard) auf Ubuntu. Wo kann ich es bekommen? serverfault.com? InformationsquelleAutor Pieter | 2010-01-17
Wie zum include-Ordner in die doxygen-Dokumentation?
1 Antworten
Ich möchte Ordner in der doxygen-Dokumentation. Habe ich versucht \Seite und \include aber es hat nicht funktioniert, weiß jemand, wie es zu tun? Hier ist der Baum : +root - +- Controller --- category.php - +- Modelle
Was sind die wichtigsten Unterschiede der Sphinx und Doxygen?
1 Antworten
Möchte ich zur Vorbereitung einer Dokumentation für eine Sammlung von Projekten, Modulen und Bibliotheken auf dem Gebiet der computer vision (meist in c++ geschrieben). Zu diesem Zweck hatte ich einen Blick auf die OpenCV-Dokumentation und wie Sie
Mithilfe von Doxygen mit Visual Studio 2010
2 Antworten
Ich Schwierigkeiten haben, sich effizient mittels Doxygen mit Visual Studio 2010 und C++. Gibt es keine andere Funktion für die Kommentare als "un - /Kommentar-Zeilen"? Zum Beispiel die Erzeugung Kommentar stubs, und das hinzufügen von /// nach