diff options
| author | 2018-09-04 10:49:06 -0400 | |
|---|---|---|
| committer | 2018-09-04 10:49:08 -0400 | |
| commit | 6ef84f1c4c6ca66ec28be210ef14913187af4424 (patch) | |
| tree | dc16d7523a1785a0bd35f79cc53fdbdc6b6e7bcf /src | |
| parent | common/logging/filter: Replace C-style case with C++ static_cast (diff) | |
| download | yuzu-6ef84f1c4c6ca66ec28be210ef14913187af4424.tar.gz yuzu-6ef84f1c4c6ca66ec28be210ef14913187af4424.tar.xz yuzu-6ef84f1c4c6ca66ec28be210ef14913187af4424.zip | |
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.
Diffstat (limited to 'src')
| -rw-r--r-- | src/common/logging/log.h | 10 | ||||
| -rw-r--r-- | 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 { | |||
| 12 | /// Specifies the severity or level of detail of the log message. | 12 | /// Specifies the severity or level of detail of the log message. |
| 13 | enum class Level : u8 { | 13 | enum class Level : u8 { |
| 14 | Trace, ///< Extremely detailed and repetitive debugging information that is likely to | 14 | Trace, ///< Extremely detailed and repetitive debugging information that is likely to |
| 15 | /// pollute logs. | 15 | ///< pollute logs. |
| 16 | Debug, ///< Less detailed debugging information. | 16 | Debug, ///< Less detailed debugging information. |
| 17 | Info, ///< Status information from important points during execution. | 17 | Info, ///< Status information from important points during execution. |
| 18 | Warning, ///< Minor or potential problems found during execution of a task. | 18 | Warning, ///< Minor or potential problems found during execution of a task. |
| 19 | Error, ///< Major problems found during execution of a task that prevent it from being | 19 | Error, ///< Major problems found during execution of a task that prevent it from being |
| 20 | /// completed. | 20 | ///< completed. |
| 21 | Critical, ///< Major problems during execution that threathen the stability of the entire | 21 | Critical, ///< Major problems during execution that threaten the stability of the entire |
| 22 | /// application. | 22 | ///< application. |
| 23 | 23 | ||
| 24 | Count ///< Total number of logging levels | 24 | Count ///< Total number of logging levels |
| 25 | }; | 25 | }; |
| @@ -49,7 +49,7 @@ enum class Class : ClassType { | |||
| 49 | Kernel, ///< The HLE implementation of the CTR kernel | 49 | Kernel, ///< The HLE implementation of the CTR kernel |
| 50 | Kernel_SVC, ///< Kernel system calls | 50 | Kernel_SVC, ///< Kernel system calls |
| 51 | Service, ///< HLE implementation of system services. Each major service | 51 | Service, ///< HLE implementation of system services. Each major service |
| 52 | /// should have its own subclass. | 52 | ///< should have its own subclass. |
| 53 | Service_ACC, ///< The ACC (Accounts) service | 53 | Service_ACC, ///< The ACC (Accounts) service |
| 54 | Service_AM, ///< The AM (Applet manager) service | 54 | Service_AM, ///< The AM (Applet manager) service |
| 55 | Service_AOC, ///< The AOC (AddOn Content) service | 55 | 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; | |||
| 15 | std::string FormatLogMessage(const Entry& entry); | 15 | std::string FormatLogMessage(const Entry& entry); |
| 16 | /// Formats and prints a log entry to stderr. | 16 | /// Formats and prints a log entry to stderr. |
| 17 | void PrintMessage(const Entry& entry); | 17 | void PrintMessage(const Entry& entry); |
| 18 | /// Prints the same message as `PrintMessage`, but colored acoording to the severity level. | 18 | /// Prints the same message as `PrintMessage`, but colored according to the severity level. |
| 19 | void PrintColoredMessage(const Entry& entry); | 19 | void PrintColoredMessage(const Entry& entry); |
| 20 | } // namespace Log | 20 | } // namespace Log |