Add <example> for API reference

Change-Id: I8e03a0c3a1d05bf915c9cfd54e22296be2446e8d
Signed-off-by: SukHyung, Kang <shine.kang@samsung.com>

diff --git a/src/Tizen.Applications.MessagePort/Tizen.Applications.Messages/MessagePort.cs b/src/Tizen.Applications.MessagePort/Tizen.Applications.Messages/MessagePort.cs
index b1bd8184b9d561b873e602483885028bb7de1dcf..5050abe10c6c5c00dda30e38b3930e24b50a501c 100755 (executable)
--- a/src/Tizen.Applications.MessagePort/Tizen.Applications.Messages/MessagePort.cs
+++ b/src/Tizen.Applications.MessagePort/Tizen.Applications.Messages/MessagePort.cs
@@ -53,9 +53,11 @@ namespace Tizen.Applications.Messages
         /// <param name="portName">The name of the local message port.</param>
         /// <param name="trusted">If true, it is the trusted message port of application, otherwise false.</param>
         /// <exception cref="System.ArgumentException">Thrown when portName is null or empty.</exception>
+        /// <example>
         /// <code>
         /// MessagePort messagePort = new MessagePort("SenderPort", true);
         /// </code>
+        /// </example>
         public MessagePort(string portName, bool trusted)
         {
             if (String.IsNullOrEmpty(portName))
@@ -77,6 +79,7 @@ namespace Tizen.Applications.Messages
         /// <summary>
         /// Called when a message is received.
         /// </summary>
+        /// <example>
         /// <code>
         /// MessagePort messagePort = new MessagePort("SenderPort", true);
         /// messagePort.MessageReceived += MessageReceivedCallback;
@@ -88,6 +91,7 @@ namespace Tizen.Applications.Messages
         ///     }
         /// }
         /// </code>
+        /// </example>
         public event EventHandler<MessageReceivedEventArgs> MessageReceived;
 
         /// <summary>
@@ -128,11 +132,13 @@ namespace Tizen.Applications.Messages
         /// <exception cref="System.InvalidOperationException">Thrown when portName is already used, when there is an I/O error.</exception>
         /// <exception cref="System.ArgumentException">Thrown when there is an invalid parameter.</exception>
         /// <exception cref="System.OutOfMemoryException">Thrown when out of memory.</exception>
+        /// <example>
         /// <code>
         /// MessagePort messagePort = new MessagePort("SenderPort", true);
         /// messagePort.MessageReceived += MessageReceivedCallback;
         /// messagePort.Listen();
         /// </code>
+        /// </example>
         public void Listen()
         {
             lock (s_lock)
@@ -178,6 +184,7 @@ namespace Tizen.Applications.Messages
         /// <exception cref="System.InvalidOperationException">Thrown when messageport is already stopped, when there is an I/O error, when the port is not found.</exception>
         /// <exception cref="System.ArgumentException">Thrown when there is an invalid parameter.</exception>
         /// <exception cref="System.OutOfMemoryException">Thrown when out of memory.</exception>
+        /// <example>
         /// <code>
         /// MessagePort messagePort = new MessagePort("SenderPort", true);
         /// messagePort.MessageReceived += MessageReceivedCallback;
@@ -189,6 +196,7 @@ namespace Tizen.Applications.Messages
         /// }
         /// messagePort.StopListening();
         /// </code>
+        /// </example>
         public void StopListening()
         {
             if (!_listening)
@@ -223,6 +231,7 @@ namespace Tizen.Applications.Messages
         /// <exception cref="System.ArgumentException">Thrown when there is an invalid parameter.</exception>
         /// <exception cref="System.OutOfMemoryException">Thrown when out of memory.</exception>
         /// <exception cref="System.ArgumentOutOfRangeException">Thrown when message has exceeded the maximum limit(4KB).</exception>
+        /// <example>
         /// <code>
         /// MessagePort messagePort = new MessagePort("SenderPort", true);
         /// messagePort.MessageReceived += MessageReceivedCallback;
@@ -233,6 +242,7 @@ namespace Tizen.Applications.Messages
         ///     messagePort.Send(message, "ReceiverAppID", "ReceiverPort");
         /// }
         /// </code>
+        /// </example>
         public void Send(Bundle message, string remoteAppId, string remotePortName)
         {
             Send(message, remoteAppId, remotePortName, false);
@@ -250,6 +260,7 @@ namespace Tizen.Applications.Messages
         /// <exception cref="System.OutOfMemoryException">Thrown when out of memory.</exception>
         /// <exception cref="System.ArgumentOutOfRangeException">Thrown when message has exceeded the maximum limit(4KB).</exception>
         /// <exception cref="System.UnauthorizedAccessException">Thrown when the remote application is not signed with the same certificate.</exception>
+        /// <example>
         /// <code>
         /// MessagePort messagePort = new MessagePort("SenderPort", true);
         /// messagePort.MessageReceived += MessageReceivedCallback;
@@ -260,6 +271,7 @@ namespace Tizen.Applications.Messages
         ///     messagePort.Send(message, "ReceiverAppID", "ReceiverPort", true);
         /// }
         /// </code>
+        /// </example>
         public void Send(Bundle message, string remoteAppId, string remotePortName, bool trusted)
         {
             if (!_listening)

diff --git a/src/Tizen.Applications.MessagePort/Tizen.Applications.Messages/RemotePort.cs b/src/Tizen.Applications.MessagePort/Tizen.Applications.Messages/RemotePort.cs
index 561948de72ac24b64b8e40a1da8d12a9ec3c449f..c589638ddd92e1a2b1d188fddfb0f9d46aa62ef6 100755 (executable)
--- a/src/Tizen.Applications.MessagePort/Tizen.Applications.Messages/RemotePort.cs
+++ b/src/Tizen.Applications.MessagePort/Tizen.Applications.Messages/RemotePort.cs
@@ -48,9 +48,11 @@ namespace Tizen.Applications.Messages
         /// <param name="portName">The name of the remote message port</param>
         /// <param name="trusted">If true is the trusted message port of application, otherwise false</param>
         /// <exception cref="System.ArgumentException">Thrown when appId is null or empty, when portName is null or empty</exception>
+        /// <example>
         /// <code>
         /// RemotePort remotePort = new RemotePort("org.tizen.example.messageport", "SenderPort", false);
         /// </code>
+        /// </example>
         public RemotePort(String appId, string portName, bool trusted)
         {
             if (String.IsNullOrEmpty(appId) || String.IsNullOrEmpty(portName))
@@ -137,10 +139,12 @@ namespace Tizen.Applications.Messages
         /// <since_tizen> 4 </since_tizen>
         /// <exception cref="System.InvalidOperationException">Thrown when there is an I/O error</exception>
         /// <exception cref="System.OutOfMemoryException">Thrown when out of memory.</exception>
+        /// <example>
         /// <code>
         /// Remote remotePort = new RemotePort("org.tizen.example", "SenderPort", true);
         /// bool isRunning = remotePort.isRunning();
         /// </code>
+        /// </example>
         /// <returns> Return true if Remote Port is running </returns>
         public bool IsRunning()
         {
@@ -169,6 +173,7 @@ namespace Tizen.Applications.Messages
         /// <since_tizen> 4 </since_tizen>
         /// <exception cref="System.InvalidOperationException">Thrown when there is an I/O error</exception>
         /// <exception cref="System.OutOfMemoryException">Thrown when out of memory.</exception>
+        /// <example>
         /// <code>
         /// Remote remotePort = new RemotePort("org.tizen.example", "SenderPort", true);
         /// remotePort.RemotePortStateChanged += RemotePortStateChangedCallback;
@@ -187,6 +192,7 @@ namespace Tizen.Applications.Messages
         ///     }
         /// }
         /// </code>
+        /// </example>
         public event EventHandler<RemotePortStateChangedEventArgs> RemotePortStateChanged
         {
             add