Frage

I have a file like:

/** @file some description */

void SomeFunc();///< brief function description

The @file keyword is needed to document global functions, as per Doxygen mailing list. So here it is, but Doxygen keeps ignoring SomeFunc(), i.e. it doesn't appear anywhere in documentation.

War es hilfreich?

Lösung

The @file keyword is used to specify the file name, not the description. Try something like this:

//!
//! @file filename.h
//! @brief some description
//!
Lizenziert unter: CC-BY-SA mit Zuschreibung
Nicht verbunden mit StackOverflow
scroll top