Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Doxygen does not generate documentation for stand alone functions

Tags:

c++

doxygen

The doxygen setup I am using works great for classes, structs, and namespaces, but does not generate any documentation for stand alone functions.

For instance, nothing is generated for these methods:

#ifndef STRING_UTILS_H
#define STRING_UTILS_H 1
/// @file

/// @brief Trim whitespace from the start of the string
/// @param s - The string to left trim
/// @return the trimmed string
std::string ltrim(const std::string& s);

/// @brief Trim whitespace from the end of the string
/// @param s - The string to right trim
/// @return the trimmed string
std::string rtrim(const std::string& s);

/// @brief Trim whitespace from both sides of the string
/// @param s - The string to trim
/// @return the trimmed string
std::string trim(const std::string& s);

#endif
like image 340
steveo225 Avatar asked Oct 19 '25 13:10

steveo225


1 Answers

SHOW_FILES must be set to YES in the Doxygen file in addition to having /// @file in the source file

like image 94
steveo225 Avatar answered Oct 22 '25 02:10

steveo225