以下是根据Doxygen标准添加的注释示例:
#include "logger.h"
#include "ErrorRecorder.h"
#include "logging.h"
// Global error recorder instance.
SampleErrorRecorder gRecorder;
namespace sample
{
/**
* @brief Global logger instance with an initial severity level set to INFO.
*/
Logger gLogger{Logger::Severity::kINFO};
/**
* @brief Log stream consumers for various logging levels.
*/
LogStreamConsumer gLogVerbose{LOG_VERBOSE(gLogger)};
LogStreamConsumer gLogInfo{LOG_INFO(gLogger)};
LogStreamConsumer gLogWarning{LOG_WARN(gLogger)};
LogStreamConsumer gLogError{LOG_ERROR(gLogger)};
LogStreamConsumer gLogFatal{LOG_FATAL(gLogger)};
/**
* @brief Sets the reportable severity level for the logger and all log stream consumers.
*
* This function updates the severity level that determines which log messages
* will be reported. All logs with a severity lower than this level will be ignored.
*
* @param severity The new severity level to set for reporting log messages.
*/
void setReportableSeverity(Logger::Severity severity)
{
gLogger.setReportableSeverity(severity);
gLogVerbose.setReportableSeverity(severity);
gLogInfo.setReportableSeverity(severity);
gLogWarning.setReportableSeverity(severity);
gLogError.setReportableSeverity(severity);
gLogFatal.setReportableSeverity(severity);
}
} // namespace sample
在这个示例中,我们为全局变量和函数添加了详细的文档注释,包括每个组件的简要说明以及setReportableSeverity
函数的参数解释。这将有助于生成清晰的API文档。
内容由零声教学AI助手提供,问题来源于学员提问