CODEWITHSUNDEEP
c++documentationdoxygen
Hi-Angel
Hi-Angel

Reputation: 5659

DoxyGen ignores functions

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.

Upvotes: 3

Views: 849

Answers (1)

piwi
piwi

Reputation: 5346

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

//!
//! @file filename.h
//! @brief some description
//!

Upvotes: 4

Related Questions