Doxygen - getting started

OP #5906100 
Hallo zusammen,

ich versuche gerade, mich in Doxygen einzuarbeiten. Die richtig gute 
Anleitung fehlt mir noch, also habe ich es einfach mal probiert, zwei 
zusammengehörige Dateien aus einem Projekt zu Doxumentieren.

Kann ein Mitleser mit etwas Erfahrung in Doxygen mal drübergucken, ob 
ich etwas Wichtiges vergessen oder falsch gemacht habe?
Angehängte Dateien:
Antwort Zitieren Bearbeiten Thread verschieben Thread sperren Langsamer Modus Anmeldepflicht aktivieren Anpinnen Thread löschen Thread mit anderem zusammenführen Melden Danke 
Der Mischmasch aus Kommentarstilen gefällt mir persönlich nicht (/// und 
/**). Weiters könnte man das @brief bei den Funktionen weglassen was den 
Lesefluss etwas erleichtern würde.

Sonst hät ich persönlich nix auszusetzen.
Antwort Zitieren Bearbeiten Löschen Melden Danke
Gast 
Würde die Parameterdokumentation hinter die Parameter setzen.

1
/** @brief Bruch kuerzen

2
 * 

3
 * @return Bruch

4
 */

5
frac64_t frac64_reduce(

6
        frac64_t F   /**< Regulaerer Bruch (Nenner nicht Null!) */

7
    )

8
{

9
    int64_t ggt = gcd_s64(F.z, F.n);

10
    assert( ggt > 0 );

11
    F.z/= ggt;

12
    F.n/= ggt;

13
    return F;

14
}


Verhindert falsche Parameternamen, ist weniger schreibarbeit, m.Mn. nach 
übersichtlicher und man sieht direkt welche Parameter noch nicht 
dokumentiert sind.
Das schließende Kommentarzeichen würde ich in eine neue Zeile setzen. 
Hat keinen Nutzen, ist m.Mn. nach schöner.
Ansonsten was Vincent schon gesagt hat würde ich mir einen Start Tag 
aussuchen und den überall durchziehen.
Antwort Zitieren Bearbeiten Löschen Melden Danke
OP 
Vincent H. schrieb:
> Weiters könnte man das @brief bei den Funktionen weglassen was den
> Lesefluss etwas erleichtern würde.

Hmm....wenn ich das @brief weglasse, fehlt die Zusammenfassung (siehe 
Screenshot). Mir wäre es auch lieber, wenn es auch ohne ginge. Gibt es 
da vielleicht einen Parameter?


öljavjkdshasdf schrieb:
> Würde die Parameterdokumentation hinter die Parameter setzen.

Wie markiert man dann [in,out] ? Ich finde leider die entsprechende 
Variante nicht in der Doku.

Edit: Habe es durch Ausprobieren gefunden:
1
/** @brief Bruch kuerzen

2
 *

3
 * @return Bruch */

4
frac64_t frac64_reduce(

5
        frac64_t F ///< [in] F Regulaerer Bruch (Nenner nicht Null!)

6
        )

7
{

8
    int64_t ggt = gcd_s64(F.z, F.n);

9
    assert( ggt > 0 );

10
    F.z/= ggt;

11
    F.n/= ggt;

12
    return F;

13
}
Angehängte Dateien:
Antwort Zitieren Bearbeiten Löschen Melden Danke 
Walter T. schrieb:
> Vincent H. schrieb:
>> Weiters könnte man das @brief bei den Funktionen weglassen was den
>> Lesefluss etwas erleichtern würde.
>
> Hmm....wenn ich das @brief weglasse, fehlt die Zusammenfassung (siehe
> Screenshot). Mir wäre es auch lieber, wenn es auch ohne ginge. Gibt es
> da vielleicht einen Parameter?

Tatsächlich, sry fürs unterschlagen:
http://www.doxygen.nl/manual/config.html#cfg_javadoc_autobrief
Antwort Zitieren Bearbeiten Löschen Melden Danke
Thread beobachten

Antwort schreiben

Eine eigene Frage? Dieser Thread ist über 7 Jahre alt. Stell sie in einem eigenen Thread – dort lesen mehr Leute mit, und sie wird öfter und schneller beantwortet.

Neuen Thread starten

Eine Lösung, Ergänzung oder Rückmeldung zu diesem Thread? Dann antworte hier.

Formatierung
  • [c]C-Code[/c]
  • [code]Code in anderen Sprachen, ASCII-Zeichnungen[/code]
  • [math]Formel in LaTeX-Syntax[/math]
  • [[Titel]] – Link zu einem Artikel
  • Verweis auf einen anderen Beitrag: Rechtsklick auf dessen Beitrags-ID (#8078628), „Adresse kopieren“, in den Text einfügen

Mehr zur Formatierung

Längeren Sourcecode als Anhang, nicht in den Text. JPG nur für Fotos und Scans; Zeichnungen und Screenshots als PNG oder GIF. Siehe Bildformate.

Dein Name und deine E-Mail-Adresse

Schon registriert? Anmelden

Wird nicht angezeigt. Wir schicken dir einen Link; sobald du damit bestätigst, erscheint dein Beitrag.

Mit dem Abschicken legst du einen kostenlosen Account an und erkennst die Nutzungsbedingungen und die Datenschutzerklärung an.