Doxygen - getting started

Walter T. OP #5906100
Lesenswert?
• ▲
▼ 
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 Anmeldepflicht aktivieren Anpinnen Thread löschen Thread mit anderem zusammenführen Beitrag melden
öljavjkdshasdf Gast #5906268
Lesenswert?
• ▲
▼ 
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 Beitrag melden
Walter T. OP #5906302
Lesenswert?
• ▲
▼ 
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 Beitrag melden
Vincent H. #5906323
Lesenswert?
• ▲
▼ 
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 Beitrag melden
Thread beobachten

Antwort schreiben

Bitte melde dich an, um einen Beitrag zu schreiben.

Bestehender Account

oder

Mit Google-Account einloggen

Noch kein Account?

Die Registrierung ist kostenlos und dauert nur eine Minute.

Jetzt registrieren