doxygen warning unterdrücken

Gast #1118840
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?
#1118850
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.
Gast #1118964
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?
#1119049
> 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.
Gast #2848101
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

Antwort schreiben

Eine eigene Frage? Dieser Thread ist über 17 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.

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.