Forum: PC-Programmierung Problem mit Doxygen: "Detailed Description" bleibt leer


von Third E. (third-eye)


Lesenswert?

Hallo,

ich habe mich mal etwas in Doxygen eingearbeitet. Es funktioniert auch 
ganz gut, bis auf ein hartnäckiges Problem.
Aber erst mal mein (fiktiver) Code:

Meine Datei fusion.c sieht folgendermaßen aus:
// ***********************************************************
/**
 * @file     fusion.c
 * @author   Emment Brown
 * @date     31.01.2014
 * @brief    Fluxkompensator-Steuerungsfunktionen
 */

void PowerUpMrFusion(uint32_t Gigawatts)
{
   ...
}
// ***********************************************************


Meine Datei fusion.h sieht folgendermaßen aus:
// ***********************************************************
/**
 *  @file            fusion.h
 *  @brief           Veroeffentlichungen von fusion.c
 *  @author          Emment Brown
 *  @date            31.01.2014
 *  @version         31.01.2014, EB
 *
 *  @{
 */

#ifndef FUSION_H
#define FUSION_H
/**  @addtogroup FUSION
     @{
     */

//Funktionsprototypen:
void PowerUpMrFusion(uint32_t Gigawatts);

/** @}
 *
 */

/** @}
 *
 */
#endif
// ***********************************************************

Das Prblem ist, dass in der erzeugten HTML-Doku unter "Modules" zwar die 
Überschrift "Detailed Description" aufgeführt wird, aber darunter es 
immer leer ist.
Wenn ich aber unter "Files" fusion.c aufrufe, wird dort die "Detailed 
Description" aufgeführt.

Wie kriege ich das hin, dass die Beschreibung auch unter dem Modul 
sichtbar ist?

Übrigens:
Das DoxyIt-Plugin für Notepad++ kann ich empfehlen. So kann man sich 
ruckzuck einen Doxygen-Rumpf für Funktionen und Dateien erstellen.

Danke
Third-Eye

: Verschoben durch Moderator
von StinkyWinky (Gast)


Lesenswert?

Versuchs mal so:

fusion.c
1
// ***********************************************************
2
/**
3
 * @file     fusion.c
4
 * @author   Emment Brown
5
 * @date     31.01.2014
6
 * @brief    Fluxkompensator-Steuerungsfunktionen
7
 * Detaillierte C_Beschreibung hier.
8
* @defgroup FUSION Gruppe Fusion
9
10
 */
11
12
void PowerUpMrFusion(uint32_t Gigawatts)
13
{
14
   ...
15
}

fusion.h
1
// ***********************************************************
2
/**
3
 *  @file            fusion.h
4
 *  @brief           Veroeffentlichungen von fusion.c
5
 *  @author          Emment Brown
6
 *  @date            31.01.2014
7
 *  @version         31.01.2014, EB
8
 *
9
@ingroup FUSION
10
*  @{
11
 * Detaillierte H-Beschreibung hier.
12
 */
13
14
#ifndef FUSION_H
15
#define FUSION_H
16
/**  @addtogroup FUSION
17
18
//Funktionsprototypen:
19
void PowerUpMrFusion(uint32_t Gigawatts);
20
21
/** @}
22
 *
23
 */
24
#endif
25
// *******

von Rolf Magnus (Gast)


Lesenswert?

Third Eye schrieb:
> Das Prblem ist, dass in der erzeugten HTML-Doku unter "Modules" zwar die
> Überschrift "Detailed Description" aufgeführt wird, aber darunter es
> immer leer ist.

In deinem Code ist ja auch nirgends eine detailierte Beschreibung.

Bitte melde dich an um einen Beitrag zu schreiben. Anmeldung ist kostenlos und dauert nur eine Minute.
Bestehender Account
Schon ein Account bei Google/GoogleMail? Keine Anmeldung erforderlich!
Mit Google-Account einloggen
Noch kein Account? Hier anmelden.