Forum: PC Hard- und Software doxygen warning unterdrücken


von Claus (Gast)


Lesenswert?

Hi, ich dokumentiere meinen Source Code mit doxygen (Version 1.5.7.1) 
folgendermaßen:
1
/*****************************************************************************//**
2
 *  \brief     activate SPI work
3
 *
4
 *  \par Modul Bios
5
 *  \param     void
6
 *  \retval    void
7
 *  \note      global routine\n
8
 *             subservice of task: profiling data, HF send data
9
 *  \par Last Change
10
 *             03.06.08 (CB) start of coding\n
11
 *****************************************************************************/
12
void ArmSpi( void )
13
{
14
}

Dabei habe ich das Problem dass doxygen immer folgende Warning bringt:
"Warning: argument 'void' of command @param is not found in the argument 
list of ArmSpi(void)"

Diese Warning ist äußerst lästig. Hat jemand ne Idee wie ich dies 
unterdrücken kann?

: Verschoben durch Moderator
von Karl-heinz S. (cletus)


Lesenswert?

Claus wrote:

> Dabei habe ich das Problem dass doxygen immer folgende Warning bringt:
> "Warning: argument 'void' of command @param is not found in the argument
> list of ArmSpi(void)"
>
> Diese Warning ist äußerst lästig. Hat jemand ne Idee wie ich dies
> unterdrücken kann?

Na dann lass doch einfach \param weg.

Gibt ja auch kein Parameter, der void heißt.

Das gleich übrigens auch bei return.

Übrigens solltest du bei return sowieso immer Semantisch schreiben, was 
die Funktion zurück gibt und nicht die Variablennamen.

von Claus (Gast)


Lesenswert?

Danke für die schnelle Antwort.

An dieser Lösung gefällt mir allerdings nicht, dass in der Doku dann 
kein

Parameters:    void

erscheint.

Gibt es denn keine Möglichkeit einzelne Warnings zu unterdrücken?

von Mano W. (Firma: ---) (manow)


Lesenswert?

> Gibt es denn keine Möglichkeit einzelne Warnings zu unterdrücken?

Wenn in der Doku dazu nichts steht, dann wird es wohl sowas nicht geben. 
Dafür gibt's den Source-Code. Viel Spaß beim Suchen.

Auf der doxygen-Seite gibt's auch noch Links zu Source-Code-Tools, vllt 
findest Du da was dir mehr entspricht.

von Michael Schoppe (Gast)


Lesenswert?

Morgen,

ich hole den Beitrag nochmal hoch, da mich auch interessieren würde wie 
man diese Warning unterdrücken kann.

Auch ich möchte bewusst in der Doku stehen haben, dass der Parameter 
void oder none ist.

Gruß
Michael Schoppe

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.