From 2f69c2b4c171cf8d639b6f4c1da2c138262e1500 Mon Sep 17 00:00:00 2001
From: coderhyme <jhyo.kim@samsung.com>
Date: Tue, 25 Jul 2017 14:09:10 +0900
Subject: [PATCH] [Vision] Fixed comment errors and added missing comments.

Change-Id: I39e96668d8da7a3a1d33425b66e70b0a1529184a
Signed-off-by: coderhyme <jhyo.kim@samsung.com>
---
 src/Tizen.Multimedia.Vision/MediaVision/Barcode.cs            |  4 ++++
 src/Tizen.Multimedia.Vision/MediaVision/BarcodeGenerator.cs   |  8 ++++----
 .../MediaVision/EngineConfiguration.cs                        |  9 +++++++++
 .../MediaVision/FaceRecognitionModel.cs                       | 11 ++++++++++-
 src/Tizen.Multimedia.Vision/MediaVision/FaceTrackingModel.cs  |  9 +++++++++
 src/Tizen.Multimedia.Vision/MediaVision/ImageObject.cs        | 10 ++++++++++
 src/Tizen.Multimedia.Vision/MediaVision/ImageTrackingModel.cs |  9 +++++++++
 src/Tizen.Multimedia.Vision/MediaVision/MediaVisionSource.cs  |  9 +++++++++
 .../MediaVision/PersonRecognitionConfiguration.cs             |  6 +++---
 src/Tizen.Multimedia.Vision/MediaVision/Quadrangle.cs         |  4 ++++
 src/Tizen.Multimedia.Vision/MediaVision/SurveillanceEngine.cs | 10 ++++++++++
 11 files changed, 81 insertions(+), 8 deletions(-)

diff --git a/src/Tizen.Multimedia.Vision/MediaVision/Barcode.cs b/src/Tizen.Multimedia.Vision/MediaVision/Barcode.cs
index 6a44d7d..9e16d8b 100755
--- a/src/Tizen.Multimedia.Vision/MediaVision/Barcode.cs
+++ b/src/Tizen.Multimedia.Vision/MediaVision/Barcode.cs
@@ -51,6 +51,10 @@ namespace Tizen.Multimedia
         /// <since_tizen> 3</since_tizen>
         public BarcodeType Type { get; }
 
+        /// <summary>
+        /// Returns a string that represents the current object.
+        /// </summary>
+        /// <value>A string that represents the current object.</value>
         public override string ToString() =>
             $"Region={Region}, Message={Message}, Type={Type.ToString()}";
     }
diff --git a/src/Tizen.Multimedia.Vision/MediaVision/BarcodeGenerator.cs b/src/Tizen.Multimedia.Vision/MediaVision/BarcodeGenerator.cs
index 2d4269d..b4be4a1 100755
--- a/src/Tizen.Multimedia.Vision/MediaVision/BarcodeGenerator.cs
+++ b/src/Tizen.Multimedia.Vision/MediaVision/BarcodeGenerator.cs
@@ -216,7 +216,7 @@ namespace Tizen.Multimedia
         /// <param name="qrConfig">The <see cref="QrConfiguration"/> instance.</param>
         /// <param name="imageConfig">The <see cref="BarcodeImageConfiguration"/> that contains information about the file to be generated.</param>
         /// <exception cref="ArgumentNullException">
-        ///     <paramref name="messsage"/> is null.\n
+        ///     <paramref name="message"/> is null.\n
         ///     -or-\n
         ///     <paramref name="qrConfig"/> is null.\n
         ///     -or-\n
@@ -250,7 +250,7 @@ namespace Tizen.Multimedia
         ///     information about the file to be generated.</param>
         /// <param name="config">The configuration of the barcode generator. This value can be null.</param>
         /// <exception cref="ArgumentNullException">
-        ///     <paramref name="messsage"/> is null.\n
+        ///     <paramref name="message"/> is null.\n
         ///     -or-\n
         ///     <paramref name="qrConfig"/> is null.\n
         ///     -or-\n
@@ -297,7 +297,7 @@ namespace Tizen.Multimedia
         /// <param name="imageConfig">The <see cref="BarcodeImageConfiguration"/> that contains
         ///     information about the file to be generated.</param>
         /// <exception cref="ArgumentNullException">
-        ///     <paramref name="messsage"/> is null.\n
+        ///     <paramref name="message"/> is null.\n
         ///     -or-\n
         ///     <paramref name="imageConfig"/> is null.
         /// </exception>
@@ -327,7 +327,7 @@ namespace Tizen.Multimedia
         ///     information about the file to be generated.</param>
         /// <param name="config">The configuration of the barcode generator. This value can be null.</param>
         /// <exception cref="ArgumentNullException">
-        ///     <paramref name="messsage"/> is null.\n
+        ///     <paramref name="message"/> is null.\n
         ///     -or-\n
         ///     <paramref name="imageConfig"/> is null.
         /// </exception>
diff --git a/src/Tizen.Multimedia.Vision/MediaVision/EngineConfiguration.cs b/src/Tizen.Multimedia.Vision/MediaVision/EngineConfiguration.cs
index 7d59ccf..354205c 100755
--- a/src/Tizen.Multimedia.Vision/MediaVision/EngineConfiguration.cs
+++ b/src/Tizen.Multimedia.Vision/MediaVision/EngineConfiguration.cs
@@ -146,12 +146,21 @@ namespace Tizen.Multimedia
             }
         }
 
+        /// <summary>
+        /// Releases all resources used by the <see cref="EngineConfiguration"/> object.
+        /// </summary>
         public void Dispose()
         {
             Dispose(true);
             GC.SuppressFinalize(this);
         }
 
+        /// <summary>
+        /// Releases the resources used by the <see cref="EngineConfiguration"/> object.
+        /// </summary>
+        /// <param name="disposing">
+        /// true to release both managed and unmanaged resources; false to release only unmanaged resources.
+        /// </param>
         protected virtual void Dispose(bool disposing)
         {
             if (_disposed)
diff --git a/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognitionModel.cs b/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognitionModel.cs
index 5b6a8bb..fc67b3d 100755
--- a/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognitionModel.cs
+++ b/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognitionModel.cs
@@ -41,7 +41,7 @@ namespace Tizen.Multimedia
         }
 
         /// <summary>
-        /// Initializes a new instance of the <see cref="FaceRecognitionModel"/> class withe the specified path.
+        /// Initializes a new instance of the <see cref="FaceRecognitionModel"/> class with the specified path.
         /// </summary>
         /// <remarks>
         /// Models have been saved by <see cref="Save()"/> can be loaded.
@@ -269,12 +269,21 @@ namespace Tizen.Multimedia
                 Validate("Failed to learn");
         }
 
+        /// <summary>
+        /// Releases all resources used by the <see cref="FaceRecognitionModel"/> object.
+        /// </summary>
         public void Dispose()
         {
             Dispose(true);
             GC.SuppressFinalize(this);
         }
 
+        /// <summary>
+        /// Releases the resources used by the <see cref="FaceRecognitionModel"/> object.
+        /// </summary>
+        /// <param name="disposing">
+        /// true to release both managed and unmanaged resources; false to release only unmanaged resources.
+        /// </param>
         protected virtual void Dispose(bool disposing)
         {
             if (_disposed)
diff --git a/src/Tizen.Multimedia.Vision/MediaVision/FaceTrackingModel.cs b/src/Tizen.Multimedia.Vision/MediaVision/FaceTrackingModel.cs
index bc54478..be9ae12 100755
--- a/src/Tizen.Multimedia.Vision/MediaVision/FaceTrackingModel.cs
+++ b/src/Tizen.Multimedia.Vision/MediaVision/FaceTrackingModel.cs
@@ -141,12 +141,21 @@ namespace Tizen.Multimedia
             ret.Validate("Failed to save tracking model to file");
         }
 
+        /// <summary>
+        /// Releases all resources used by the <see cref="FaceTrackingModel"/> object.
+        /// </summary>
         public void Dispose()
         {
             Dispose(true);
             GC.SuppressFinalize(this);
         }
 
+        /// <summary>
+        /// Releases the resources used by the <see cref="FaceTrackingModel"/> object.
+        /// </summary>
+        /// <param name="disposing">
+        /// true to release both managed and unmanaged resources; false to release only unmanaged resources.
+        /// </param>
         protected virtual void Dispose(bool disposing)
         {
             if (_disposed)
diff --git a/src/Tizen.Multimedia.Vision/MediaVision/ImageObject.cs b/src/Tizen.Multimedia.Vision/MediaVision/ImageObject.cs
index e56967e..ac932c5 100755
--- a/src/Tizen.Multimedia.Vision/MediaVision/ImageObject.cs
+++ b/src/Tizen.Multimedia.Vision/MediaVision/ImageObject.cs
@@ -257,12 +257,22 @@ namespace Tizen.Multimedia
         #endregion
 
         #region IDisposable-support
+
+        /// <summary>
+        /// Releases all resources used by the <see cref="ImageObject"/> object.
+        /// </summary>
         public void Dispose()
         {
             Dispose(true);
             GC.SuppressFinalize(this);
         }
 
+        /// <summary>
+        /// Releases the resources used by the <see cref="ImageObject"/> object.
+        /// </summary>
+        /// <param name="disposing">
+        /// true to release both managed and unmanaged resources; false to release only unmanaged resources.
+        /// </param>
         protected virtual void Dispose(bool disposing)
         {
             if (_disposed)
diff --git a/src/Tizen.Multimedia.Vision/MediaVision/ImageTrackingModel.cs b/src/Tizen.Multimedia.Vision/MediaVision/ImageTrackingModel.cs
index c727d28..8c86572 100755
--- a/src/Tizen.Multimedia.Vision/MediaVision/ImageTrackingModel.cs
+++ b/src/Tizen.Multimedia.Vision/MediaVision/ImageTrackingModel.cs
@@ -132,12 +132,21 @@ namespace Tizen.Multimedia
             ret.Validate("Failed to save tracking model to file");
         }
 
+        /// <summary>
+        /// Releases all resources used by the <see cref="ImageTrackingModel"/> object.
+        /// </summary>
         public void Dispose()
         {
             Dispose(true);
             GC.SuppressFinalize(this);
         }
 
+        /// <summary>
+        /// Releases the resources used by the <see cref="ImageTrackingModel"/> object.
+        /// </summary>
+        /// <param name="disposing">
+        /// true to release both managed and unmanaged resources; false to release only unmanaged resources.
+        /// </param>
         protected virtual void Dispose(bool disposing)
         {
             if (_disposed)
diff --git a/src/Tizen.Multimedia.Vision/MediaVision/MediaVisionSource.cs b/src/Tizen.Multimedia.Vision/MediaVision/MediaVisionSource.cs
index 3bb4c2f..28ce4d9 100755
--- a/src/Tizen.Multimedia.Vision/MediaVision/MediaVisionSource.cs
+++ b/src/Tizen.Multimedia.Vision/MediaVision/MediaVisionSource.cs
@@ -198,12 +198,21 @@ namespace Tizen.Multimedia
             }
         }
 
+        /// <summary>
+        /// Releases all resources used by the <see cref="MediaVisionSource"/> object.
+        /// </summary>
         public void Dispose()
         {
             Dispose(true);
             GC.SuppressFinalize(this);
         }
 
+        /// <summary>
+        /// Releases the resources used by the <see cref="MediaVisionSource"/> object.
+        /// </summary>
+        /// <param name="disposing">
+        /// true to release both managed and unmanaged resources; false to release only unmanaged resources.
+        /// </param>
         protected virtual void Dispose(bool disposing)
         {
             if (_disposed)
diff --git a/src/Tizen.Multimedia.Vision/MediaVision/PersonRecognitionConfiguration.cs b/src/Tizen.Multimedia.Vision/MediaVision/PersonRecognitionConfiguration.cs
index 867de87..dd179a3 100755
--- a/src/Tizen.Multimedia.Vision/MediaVision/PersonRecognitionConfiguration.cs
+++ b/src/Tizen.Multimedia.Vision/MediaVision/PersonRecognitionConfiguration.cs
@@ -32,7 +32,7 @@ namespace Tizen.Multimedia
         /// <param name="modelPath">Path to the face recognition model.</param>
         /// <exception cref="ArgumentNullException"><paramref name="modelPath"/> is null.</exception>
         /// <exception cref="NotSupportedException">The feature is not supported.</exception>
-        /// <since_tizen> 3</since_tizen>
+        /// <since_tizen>3</since_tizen>
         public PersonRecognitionConfiguration(string modelPath)
         {
             FaceRecognitionModelPath = modelPath;
@@ -41,9 +41,9 @@ namespace Tizen.Multimedia
         /// <summary>
         /// Gets or sets face recognition model file path.
         /// </summary>
-        /// <exception cref="ArgumentNullException"><paramref name="modelPath"/> is null.</exception>
+        /// <exception cref="ArgumentNullException"><paramref name="value"/> is null.</exception>
         /// <exception cref="ObjectDisposedException">The <see cref="PersonRecognitionConfiguration"/> already has been disposed of.</exception>
-        /// <since_tizen> 3</since_tizen>
+        /// <since_tizen>3</since_tizen>
         public string FaceRecognitionModelPath
         {
             get
diff --git a/src/Tizen.Multimedia.Vision/MediaVision/Quadrangle.cs b/src/Tizen.Multimedia.Vision/MediaVision/Quadrangle.cs
index cc394c9..64f1175 100755
--- a/src/Tizen.Multimedia.Vision/MediaVision/Quadrangle.cs
+++ b/src/Tizen.Multimedia.Vision/MediaVision/Quadrangle.cs
@@ -48,6 +48,10 @@ namespace Tizen.Multimedia
         /// <since_tizen> 3</since_tizen>
         public Point[] Points { get; }
 
+        /// <summary>
+        /// Returns a string that represents the current object.
+        /// </summary>
+        /// <value>A string that represents the current object.</value>
         public override string ToString() =>
             $"[{{{Points[0].ToString()}}}, {{{Points[1].ToString()}}}, {{{Points[2].ToString()}}}, {{{Points[3].ToString()}}}]";
     }
diff --git a/src/Tizen.Multimedia.Vision/MediaVision/SurveillanceEngine.cs b/src/Tizen.Multimedia.Vision/MediaVision/SurveillanceEngine.cs
index b06c503..f1ce4ec 100755
--- a/src/Tizen.Multimedia.Vision/MediaVision/SurveillanceEngine.cs
+++ b/src/Tizen.Multimedia.Vision/MediaVision/SurveillanceEngine.cs
@@ -129,12 +129,22 @@ namespace Tizen.Multimedia
             UnsubscribeEventTrigger(Handle, source.StreamId).Validate("Failed to unsubscribe event trigger");
         }
 
+
+        /// <summary>
+        /// Releases all resources used by the <see cref="SurveillanceEngine"/> object.
+        /// </summary>
         public void Dispose()
         {
             Dispose(true);
             GC.SuppressFinalize(this);
         }
 
+        /// <summary>
+        /// Releases the resources used by the <see cref="SurveillanceEngine"/> object.
+        /// </summary>
+        /// <param name="disposing">
+        /// true to release both managed and unmanaged resources; false to release only unmanaged resources.
+        /// </param>
         protected virtual void Dispose(bool disposing)
         {
             if (_disposed)
-- 
2.7.4