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
SHOW_FILES
must be set to YES
in the Doxygen file in addition to having /// @file
in the source file
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With