mikrocontroller.net

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


Autor: Claus (Gast)
Datum:

Bewertung
0 lesenswert
nicht lesenswert
Hi, ich dokumentiere meinen Source Code mit doxygen (Version 1.5.7.1) 
folgendermaßen:
/*****************************************************************************//**
 *  \brief     activate SPI work
 *
 *  \par Modul Bios
 *  \param     void
 *  \retval    void
 *  \note      global routine\n
 *             subservice of task: profiling data, HF send data
 *  \par Last Change
 *             03.06.08 (CB) start of coding\n
 *****************************************************************************/
void ArmSpi( void )
{
}

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
Autor: Karl-heinz Strunk (cletus)
Datum:

Bewertung
0 lesenswert
nicht 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.

Autor: Claus (Gast)
Datum:

Bewertung
0 lesenswert
nicht 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?

Autor: Mano Wee (Firma: ---) (manow)
Datum:

Bewertung
0 lesenswert
nicht 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.

Autor: Michael Schoppe (Gast)
Datum:

Bewertung
0 lesenswert
nicht 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

Antwort schreiben

Die Angabe einer E-Mail-Adresse ist freiwillig. Wenn Sie automatisch per E-Mail über Antworten auf Ihren Beitrag informiert werden möchten, melden Sie sich bitte an.

Wichtige Regeln - erst lesen, dann posten!

  • Groß- und Kleinschreibung verwenden
  • Längeren Sourcecode nicht im Text einfügen, sondern als Dateianhang

Formatierung (mehr Informationen...)

  • [c]C-Code[/c]
  • [avrasm]AVR-Assembler-Code[/avrasm]
  • [code]Code in anderen Sprachen, ASCII-Zeichnungen[/code]
  • [math]Formel in LaTeX-Syntax[/math]
  • [[Titel]] - Link zu Artikel
  • Verweis auf anderen Beitrag einfügen: Rechtsklick auf Beitragstitel,
    "Adresse kopieren", und in den Text einfügen




Bild automatisch verkleinern, falls nötig
Bitte das JPG-Format nur für Fotos und Scans verwenden!
Zeichnungen und Screenshots im PNG- oder
GIF-Format hochladen. Siehe Bildformate.
Hinweis: der ursprüngliche Beitrag ist mehr als 6 Monate alt.
Bitte hier nur auf die ursprüngliche Frage antworten,
für neue Fragen einen neuen Beitrag erstellen.

Mit dem Abschicken bestätigst du, die Nutzungsbedingungen anzuerkennen.