Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Tizen.Log: update descriptions of log class/methods #6384

Merged
merged 1 commit into from
Sep 30, 2024
Merged

Tizen.Log: update descriptions of log class/methods #6384

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 20 additions & 18 deletions src/Tizen.Log/Tizen/Log.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ public class Log
{
private static char[] sep = { '\\', '/' };
/// <summary>
/// Prints a log message with the VERBOSE priority.
/// Prints a regular log message with the VERBOSE priority.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="tag">The tag name of the log message.</param>
Expand All @@ -171,7 +171,7 @@ public static void Verbose(string tag, string message, [CallerFilePath] string f
}

/// <summary>
/// Prints a log message with the DEBUG priority.
/// Prints a regular log message with the DEBUG priority.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="tag">The tag name of the log message.</param>
Expand All @@ -185,7 +185,7 @@ public static void Debug(string tag, string message, [CallerFilePath] string fil
}

/// <summary>
/// Prints a log message with the INFO priority.
/// Prints a regular log message with the INFO priority.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="tag">The tag name of the log message.</param>
Expand All @@ -199,7 +199,7 @@ public static void Info(string tag, string message, [CallerFilePath] string file
}

/// <summary>
/// Prints a log message with the WARNING priority.
/// Prints a regular log message with the WARNING priority.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="tag">The tag name of the log message.</param>
Expand All @@ -213,7 +213,7 @@ public static void Warn(string tag, string message, [CallerFilePath] string file
}

/// <summary>
/// Prints a log message with the ERROR priority.
/// Prints a regular log message with the ERROR priority.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="tag">The tag name of the log message.</param>
Expand All @@ -227,7 +227,7 @@ public static void Error(string tag, string message, [CallerFilePath] string fil
}

/// <summary>
/// Prints a log message with the FATAL priority.
/// Prints a regular log message with the FATAL priority.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="tag">The tag name of the log message.</param>
Expand All @@ -248,14 +248,15 @@ static unsafe void Print(Interop.Dlog.LogPriority priority, string tag, string m

/// <summary>
/// Provides methods to print log messages to the Tizen logging system.
/// Sends "internal" logs, which end up in a different Dlog buffer than regular logs.
/// </summary>
/// <since_tizen> 3 </since_tizen>
[EditorBrowsable(EditorBrowsableState.Never)]
public class InternalLog
{
private static char[] sep = { '\\', '/' };
/// <summary>
/// Prints a log message with the VERBOSE priority.
/// Prints an internal log message with the VERBOSE priority.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="tag">The tag name of the log message.</param>
Expand All @@ -270,7 +271,7 @@ public static void Verbose(string tag, string message, [CallerFilePath] string f
}

/// <summary>
/// Prints a log message with the DEBUG priority.
/// Prints an internal log message with the DEBUG priority.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="tag">The tag name of the log message.</param>
Expand All @@ -284,7 +285,7 @@ public static void Debug(string tag, string message, [CallerFilePath] string fil
}

/// <summary>
/// Prints a log message with the INFO priority.
/// Prints an internal log message with the INFO priority.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="tag">The tag name of the log message.</param>
Expand All @@ -298,7 +299,7 @@ public static void Info(string tag, string message, [CallerFilePath] string file
}

/// <summary>
/// Prints a log message with the WARNING priority.
/// Prints an internal log message with the WARNING priority.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="tag">The tag name of the log message.</param>
Expand All @@ -312,7 +313,7 @@ public static void Warn(string tag, string message, [CallerFilePath] string file
}

/// <summary>
/// Prints a log message with the ERROR priority.
/// Prints an internal log message with the ERROR priority.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="tag">The tag name of the log message.</param>
Expand All @@ -326,7 +327,7 @@ public static void Error(string tag, string message, [CallerFilePath] string fil
}

/// <summary>
/// Prints a log message with the FATAL priority.
/// Prints an internal log message with the FATAL priority.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="tag">The tag name of the log message.</param>
Expand All @@ -347,14 +348,15 @@ static unsafe void Print(Interop.Dlog.LogID log_id, Interop.Dlog.LogPriority pri

/// <summary>
/// Provides methods to print log messages to the Tizen logging system.
/// Sends "secure" logs, which have extra safety not to appear on release builds.
/// </summary>
/// <since_tizen> 3 </since_tizen>
[EditorBrowsable(EditorBrowsableState.Never)]
public class SecureLog
{
private static char[] sep = { '\\', '/' };
/// <summary>
/// Prints a log message with the VERBOSE priority.
/// Prints a secure log message with the VERBOSE priority.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="tag">The tag name of the log message.</param>
Expand All @@ -369,7 +371,7 @@ public static void Verbose(string tag, string message, [CallerFilePath] string f
}

/// <summary>
/// Prints a log message with the DEBUG priority.
/// Prints a secure log message with the DEBUG priority.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="tag">The tag name of the log message.</param>
Expand All @@ -383,7 +385,7 @@ public static void Debug(string tag, string message, [CallerFilePath] string fil
}

/// <summary>
/// Prints a log message with the INFO priority.
/// Prints a secure log message with the INFO priority.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="tag">The tag name of the log message.</param>
Expand All @@ -397,7 +399,7 @@ public static void Info(string tag, string message, [CallerFilePath] string file
}

/// <summary>
/// Prints a log message with the WARNING priority.
/// Prints a secure log message with the WARNING priority.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="tag">The tag name of the log message.</param>
Expand All @@ -411,7 +413,7 @@ public static void Warn(string tag, string message, [CallerFilePath] string file
}

/// <summary>
/// Prints a log message with the ERROR priority.
/// Prints a secure log message with the ERROR priority.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="tag">The tag name of the log message.</param>
Expand All @@ -425,7 +427,7 @@ public static void Error(string tag, string message, [CallerFilePath] string fil
}

/// <summary>
/// Prints a log message with the FATAL priority.
/// Prints a secure log message with the FATAL priority.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="tag">The tag name of the log message.</param>
Expand Down
Loading