lvella/suyu
1
0
Fork 0
forked from suyu/suyu
Code Pull requests Activity

common/logging: Amend documentation comments

Browse source 
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.
This commit is contained in:
Lioncash 2018-09-04 10:49:06 -04:00
parent 2949d9552c
commit 6ef84f1c4c
2 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
src/common/logging/log.h
View file

@ -12,14 +12,14 @@ namespace Log {
/// Specifies the severity or level of detail of the log message. /// Specifies the severity or level of detail of the log message.
enum class Level : u8 { enum class Level : u8 {
Trace, ///< Extremely detailed and repetitive debugging information that is likely to Trace, ///< Extremely detailed and repetitive debugging information that is likely to
/// pollute logs. ///< pollute logs.
Debug, ///< Less detailed debugging information. Debug, ///< Less detailed debugging information.
Info, ///< Status information from important points during execution. Info, ///< Status information from important points during execution.
Warning, ///< Minor or potential problems found during execution of a task. 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 Error, ///< Major problems found during execution of a task that prevent it from being
/// completed. ///< completed.
Critical, ///< Major problems during execution that threathen the stability of the entire Critical, ///< Major problems during execution that threaten the stability of the entire
/// application. ///< application.
Count ///< Total number of logging levels Count ///< Total number of logging levels
}; };
@ -49,7 +49,7 @@ enum class Class : ClassType {
Kernel, ///< The HLE implementation of the CTR kernel Kernel, ///< The HLE implementation of the CTR kernel
Kernel_SVC, ///< Kernel system calls Kernel_SVC, ///< Kernel system calls
Service, ///< HLE implementation of system services. Each major service 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_ACC, ///< The ACC (Accounts) service
Service_AM, ///< The AM (Applet manager) service Service_AM, ///< The AM (Applet manager) service
Service_AOC, ///< The AOC (AddOn Content) service Service_AOC, ///< The AOC (AddOn Content) service

2
src/common/logging/text_formatter.h
View file

@ -15,6 +15,6 @@ struct Entry;
std::string FormatLogMessage(const Entry& entry); std::string FormatLogMessage(const Entry& entry);
/// Formats and prints a log entry to stderr. /// Formats and prints a log entry to stderr.
void PrintMessage(const Entry& entry); 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); void PrintColoredMessage(const Entry& entry);
} // namespace Log } // namespace Log