Add API Documentation Comments as Doxygen
authorjoon.c.baek <joon.c.baek@samsung.com>
Wed, 12 Oct 2016 02:30:13 +0000 (11:30 +0900)
committerChangjoon Baek <joon.c.baek@samsung.com>
Wed, 12 Oct 2016 04:28:46 +0000 (13:28 +0900)
Add Tizen.Tracer C# API Documentation Comments
as follow Doxygen generation rule.

This comments refered from Tizen2.4 API.

Change-Id: Ic18e7cb6007e612130f067af667bacc01be60094
Signed-off-by: joon.c.baek <joon.c.baek@samsung.com>
src/Tizen.Tracer/Tizen/Tracer.cs
tizen [new submodule]

index ea7bf58..676f290 100755 (executable)
@@ -10,28 +10,74 @@ using System;
 
 namespace Tizen
 {
+    /// <summary>
+    /// Provides functions for writing trace message to the system trace buffer.
+    /// </summary>
     public static class Tracer
     {
+        /// <summary>
+        /// Writes a trace event to indicate that a synchronous event has begun.
+        /// </summary>
+        /// <remarks>
+        /// The specific error code can be obtained using the Tizen.Internals.Errors.ErrorFacts.GetLastResult() method.
+        /// </remarks>
+        /// <param name="name">The name of event (optionally containing format specifiers)</param>
+        /// <seealso cref="Tizen.Tracer.End()"/>
         public static void Begin (String name)
         {
             Interop.Tracer.Begin (name);
         }
 
+        /// <summary>
+        /// Writes a trace event to indicate that the synchronous event has ended.
+        /// </summary>
+        /// <remarks>
+        /// Tizen.Tracer.End() ends the most recently called Tizen.Tracer.Begin().
+        /// The specific error code can be obtained using the Tizen.Internals.Errors.ErrorFacts.GetLastResult() method.
+        /// </remarks>
+        /// <seealso cref="Tizen.Tracer.Begin()"/>
         public static void End ()
         {
             Interop.Tracer.End ();
         }
 
+        /// <summary>
+        /// Writes a trace event to indicate that an asynchronous event has begun.
+        /// </summary>
+        /// <remarks>
+        /// The specific error code can be obtained using the Tizen.Internals.Errors.ErrorFacts.GetLastResult() method.
+        /// </remarks>
+        /// <param name="cookie">An unique identifier for distinguishing simultaneous events</param>
+        /// <param name="name">The name of event (optionally containing format specifiers)</param>
+        /// <seealso cref="Tizen.Tracer.AsyncEnd()"/>
         public static void AsyncBegin (int cookie, String name)
         {
             Interop.Tracer.AsyncBegin (cookie, name);
         }
 
+        /// <summary>
+        /// Writes a trace event to indicate that the asynchronous event has ended.
+        /// </summary>
+        /// <remarks>
+        /// Tizen.Tracer.AsyncEnd() ends matched Tizen.Tracer.AsyncBegin() which has same cookie and name.
+        /// The specific error code can be obtained using the Tizen.Internals.Errors.ErrorFacts.GetLastResult() method.
+        /// </remarks>
+        /// <param name="cookie">An unique identifier for distinguishing simultaneous events</param>
+        /// <param name="name">The name of event (optionally containing format specifiers)</param>
+        /// <seealso cref="Tizen.Tracer.AsyncBegin()"/>
         public static void AsyncEnd (int cookie, String name)
         {
             Interop.Tracer.AsyncEnd (cookie, name);
         }
 
+        /// <summary>
+        /// Writes a trace event to track change of integer value.
+        /// </summary>
+        /// <remarks>
+        /// The specific error code can be obtained using the Tizen.Internals.Errors.ErrorFacts.GetLastResult() method.
+        /// </remarks>
+        /// <param name="value">The integer variable to trace</param>
+        /// <param name="name">The name of event (optionally containing format specifiers)</param>
         public static void TraceValue (int value, String name)
         {
             Interop.Tracer.TraceValue (value, name);
diff --git a/tizen b/tizen
new file mode 160000 (submodule)
index 0000000..5b28ce1
--- /dev/null
+++ b/tizen
@@ -0,0 +1 @@
+Subproject commit 5b28ce1f0034ec639aba015b4e5a97a1f487abff