From: Krzysztof Dynowski <k.dynowski@samsung.com>
Date: Thu, 25 May 2017 07:43:01 +0000 (+0200)
Subject: API Documentation fixes
X-Git-Tag: accepted/tizen/unified/20170531.082654~1
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=refs%2Fchanges%2F48%2F131048%2F2;p=platform%2Fcore%2Fcsapi%2Flibteec.git

API Documentation fixes

Change-Id: I5dea9743eda355b70a594116785093f154951b7c
---

diff --git a/Tizen.Security.TEEC/Tizen.Security.TEEC/Libteec.cs b/Tizen.Security.TEEC/Tizen.Security.TEEC/Libteec.cs
index 72e9ec2..5393400 100644
--- a/Tizen.Security.TEEC/Tizen.Security.TEEC/Libteec.cs
+++ b/Tizen.Security.TEEC/Tizen.Security.TEEC/Libteec.cs
@@ -132,7 +132,7 @@ namespace Tizen.Security.TEEC
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         /// <param name="data">Source data buffer to copy data from</param>
-        /// <param name="dstOffs">Starting offset in source shared memory</param>
+        /// <param name="dstOffs">Starting offset in destination shared memory</param>
         /// <exception cref="InvalidOperationException">The operation is invalid.</exception>
         public void SetData(byte[] data, int dstOffs)
         {
@@ -145,7 +145,7 @@ namespace Tizen.Security.TEEC
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         /// <param name="data">Destination data buffer to copy data into</param>
-        /// <param name="dstOffs">Starting offset in destination shared memory</param>
+        /// <param name="srcOffs">Starting offset in source shared memory</param>
         /// <exception cref="InvalidOperationException">The operation is invalid.</exception>
         public void GetData(byte[] data, int srcOffs)
         {
@@ -438,7 +438,7 @@ namespace Tizen.Security.TEEC
         /// <summary>
         /// This function opens a new Session between the Client Application and the specified Trusted Application.
         /// The target Trusted Application is identified by a UUID passed in the parameter destination.
-        /// There can be up to four Parameter objects given in the {paramlist} array
+        /// There can be up to four Parameter objects given in the <paramref name="paramlist"/> array
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         /// <param name="destination">The UUID of destination TA</param>
@@ -581,6 +581,8 @@ namespace Tizen.Security.TEEC
 
         /// <summary>
         /// This function deregisters or deallocates a previously initialized block of Shared Memory.
+        /// </summary>
+        /// <remarks>
         /// For a memory buffer allocated using AllocateSharedMemory the Implementation MUST free the
         /// underlying memory and the Client Application MUST NOT access this region after this function has been
         /// called. In this case the Implementation MUST clear the buffer and size fields of the sharedMem
@@ -588,7 +590,7 @@ namespace Tizen.Security.TEEC
         /// For memory registered using RegisterSharedMemory the implementation MUST deregister the
         /// underlying memory from the TEE, but the memory region will stay available to the Client Application for
         /// other purposes as the memory is owned by it.
-        /// </summary>
+        /// </remarks>
         /// <since_tizen> 3 </since_tizen>
         /// <param name="shm">The shared memory object returned by RegisterSharedMemory or AllocateSharedMemory</param>
         /// <privilege>http://tizen.org/privilege/tee.client</privilege>