Add comments for DbgPort.cs
authorGeunsun, Lee <gs86.lee@samsung.com>
Tue, 28 Mar 2017 11:37:38 +0000 (20:37 +0900)
committerChulSeung Kim <charles0.kim@samsung.com>
Thu, 8 Jun 2017 09:34:51 +0000 (18:34 +0900)
Change-Id: I5913d6739d44ebc52c2f0032a9ed55c8394d2004

LibTVRefCommonTizen/Ports/DbgPort.cs

index 24a10f5..c530c5e 100644 (file)
@@ -23,8 +23,8 @@ using System;
 namespace LibTVRefCommonTizen.Ports
 {
     /// <summary>
-    /// Platform dependent implementation for the Logging and the Popup displaying.
-    /// DbgPort is implementing IDebuggingAPIs which is defined in Calculator shared project.
+    /// Platform dependent implementation for the Logging and the Popup displaying
+    /// DbgPort is implementing IDebuggingAPIs which is defined in Calculator shared project
     /// </summary>
     /// <remarks>
     /// Please refer to Xamarin Dependency Service
@@ -33,7 +33,9 @@ namespace LibTVRefCommonTizen.Ports
     public class DbgPort : IDebuggingAPIs
     {
         /// <summary>
-        /// A TV Home Windows reference. This is used to display a Dialog</summary>
+        /// A TV Home Windows reference
+        /// This is used to display a Dialog
+        /// </summary>
         public static Xamarin.Forms.Platform.Tizen.Native.Window MainWindow
         {
             set;
@@ -41,7 +43,8 @@ namespace LibTVRefCommonTizen.Ports
         }
 
         /// <summary>
-        /// A Logging Tag. </summary>
+        /// A Logging Tag
+        /// </summary>
         public static string TAG = "home";
 
         public static string Prefix
@@ -51,24 +54,32 @@ namespace LibTVRefCommonTizen.Ports
         }
 
         /// <summary>
-        /// A method displays a debugging log. </summary>
-        /// <param name="message"> A debugging message.</param>
+        /// Displays a log message which developer want to check
+        /// </summary>
+        /// <param name="message"> A debugging message </param>
+        /// <param name="file"> A file name that debugging message is exist </param>
+        /// <param name="func"> A function name that debugging message is exist </param>
+        /// <param name="line"> A line number that debugging message is exist </param>
         public void Dbg(string message, String file, String func, Int32 line)
         {
             D(message, file, func, line);
         }
 
         /// <summary>
-        /// A method displays a error log. </summary>
-        /// <param name="message"> A error message.</param>
+        /// </summary>
+        /// <param name="message"> A debugging message </param>
+        /// <param name="file"> A file name that debugging message is exist </param>
+        /// <param name="func"> A function name that debugging message is exist </param>
+        /// <param name="line"> A line number that debugging message is exist </param>
         public void Err(string message, String file, String func, Int32 line)
         {
             E(message, file, func, line);
         }
 
         /// <summary>
-        /// A method displays a dialog with a given message. </summary>
-        /// <param name="message"> A debugging message.</param>
+        ///Displays a dialog with a given message
+        /// </summary>
+        /// <param name="message"> A debugging message </param>
         public void Popup(string message)
         {
             if (MainWindow == null)
@@ -87,16 +98,29 @@ namespace LibTVRefCommonTizen.Ports
             toast.Show();
         }
 
+        /// <summary>
+        /// Displays a log message which developer want to check
+        /// </summary>
+        /// <param name="message"> A debugging message </param>
+        /// <param name="file"> A file name that debugging message is exist </param>
+        /// <param name="func"> A function name that debugging message is exist </param>
+        /// <param name="line"> A line number that debugging message is exist </param>
         public static void D(string message, [CallerFilePath] System.String file = "", [CallerMemberName] System.String func = "", [CallerLineNumber] System.Int32 line = 0)
         {
             Log.Debug(TAG, Prefix + ", " + message, file, func, line);
 
         }
 
+        /// <summary>
+        /// Displays a error log message
+        /// </summary>
+        /// <param name="message"> A debugging message </param>
+        /// <param name="file"> A file name that debugging message is exist </param>
+        /// <param name="func"> A function name that debugging message is exist </param>
+        /// <param name="line"> A line number that debugging message is exist </param>
         public static void E(string message, [CallerFilePath] System.String file = "", [CallerMemberName] System.String func = "", [CallerLineNumber] System.Int32 line = 0)
         {
             Log.Error(TAG, Prefix + ", " + message, file, func, line);
         }
-
     }
 }
\ No newline at end of file