From 6ef84f1c4c6ca66ec28be210ef14913187af4424 Mon Sep 17 00:00:00 2001 From: Lioncash Date: Tue, 4 Sep 2018 10:49:06 -0400 Subject: [PATCH] common/logging: Amend documentation comments Multi-line doc comments still need the '<' after the ///, otherwise it's treated as a regular comment and makes the original doc comment broken in viewers, IDEs, etc. While we're at it, also fix some typos in the comments. --- src/common/logging/log.h | 10 +++++----- src/common/logging/text_formatter.h | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/src/common/logging/log.h b/src/common/logging/log.h index e12f47f8f..4d577524f 100644 --- a/src/common/logging/log.h +++ b/src/common/logging/log.h @@ -12,14 +12,14 @@ namespace Log { /// Specifies the severity or level of detail of the log message. enum class Level : u8 { Trace, ///< Extremely detailed and repetitive debugging information that is likely to - /// pollute logs. + ///< pollute logs. Debug, ///< Less detailed debugging information. Info, ///< Status information from important points during execution. Warning, ///< Minor or potential problems found during execution of a task. Error, ///< Major problems found during execution of a task that prevent it from being - /// completed. - Critical, ///< Major problems during execution that threathen the stability of the entire - /// application. + ///< completed. + Critical, ///< Major problems during execution that threaten the stability of the entire + ///< application. Count ///< Total number of logging levels }; @@ -49,7 +49,7 @@ enum class Class : ClassType { Kernel, ///< The HLE implementation of the CTR kernel Kernel_SVC, ///< Kernel system calls Service, ///< HLE implementation of system services. Each major service - /// should have its own subclass. + ///< should have its own subclass. Service_ACC, ///< The ACC (Accounts) service Service_AM, ///< The AM (Applet manager) service Service_AOC, ///< The AOC (AddOn Content) service diff --git a/src/common/logging/text_formatter.h b/src/common/logging/text_formatter.h index 9609cec7c..b6d9e57c8 100644 --- a/src/common/logging/text_formatter.h +++ b/src/common/logging/text_formatter.h @@ -15,6 +15,6 @@ struct Entry; std::string FormatLogMessage(const Entry& entry); /// Formats and prints a log entry to stderr. void PrintMessage(const Entry& entry); -/// Prints the same message as `PrintMessage`, but colored acoording to the severity level. +/// Prints the same message as `PrintMessage`, but colored according to the severity level. void PrintColoredMessage(const Entry& entry); } // namespace Log