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
Gast
#3518329
Versuchs mal so: fusion.c
1 | |
2 | |
3 | |
4 | |
5 | |
6 | |
7 | |
8 | |
9 | |
10 | |
11 | |
12 | |
13 | |
14 | |
15 | |
fusion.h
1 | |
2 | |
3 | |
4 | |
5 | |
6 | |
7 | |
8 | |
9 | |
10 | |
11 | |
12 | |
13 | |
14 | |
15 | |
16 | |
17 | |
18 | |
19 | |
20 | |
21 | |
22 | |
23 | |
24 | |
25 | |
Gast
#3519638
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.
Antwort schreiben
Bitte melde dich an, um einen Beitrag zu schreiben.