[Vision] Update descriptions to fix ths grammer errors.

[platform/core/csapi/tizenfx.git] / src / Tizen.Multimedia.Vision / MediaVision / ImageObject.cs

diff --git a/src/Tizen.Multimedia.Vision/MediaVision/ImageObject.cs b/src/Tizen.Multimedia.Vision/MediaVision/ImageObject.cs
old mode 100644 (file)
new mode 100755 (executable)
index d66effc..c8d2c70
--- a/src/Tizen.Multimedia.Vision/MediaVision/ImageObject.cs
+++ b/src/Tizen.Multimedia.Vision/MediaVision/ImageObject.cs
@@ -18,11 +18,12 @@ using System;
 using System.IO;
 using InteropImage = Interop.MediaVision.Image;
 
-namespace Tizen.Multimedia
+namespace Tizen.Multimedia.Vision
 {
     /// <summary>
     /// Represents an image object.
     /// </summary>
+    /// <since_tizen> 3 </since_tizen>
     public class ImageObject : IDisposable
     {
         private IntPtr _handle = IntPtr.Zero;
@@ -32,6 +33,7 @@ namespace Tizen.Multimedia
         /// Initializes a new instance of the <see cref="ImageObject"/> class.
         /// </summary>
         /// <exception cref="NotSupportedException">The feature is not supported.</exception>
+        /// <since_tizen> 3 </since_tizen>
         public ImageObject()
         {
             InteropImage.Create(out _handle).Validate("Failed to create image object");
@@ -48,11 +50,12 @@ namespace Tizen.Multimedia
         /// <exception cref="FileNotFoundException"><paramref name="path"/> is invalid.</exception>
         /// <exception cref="NotSupportedException">
         ///     The feature is not supported.\n
-        ///     - or -\n
+        ///     -or-\n
         ///     <paramref name="path"/> is not supported file.
         /// </exception>
         /// <exception cref="UnauthorizedAccessException">No permission to access the specified file.</exception>
         /// <seealso cref="Save(string)"/>
+        /// <since_tizen> 3 </since_tizen>
         public ImageObject(string path)
         {
             if (path == null)
@@ -80,13 +83,16 @@ namespace Tizen.Multimedia
         /// </value>
         /// <exception cref="ObjectDisposedException">The <see cref="ImageObject"/> has already been disposed of.</exception>
         /// <seealso cref="ImageFillConfiguration"/>
-        /// <seealso cref="Fill(MediaVisionSource, ImageFillConfiguration, Rectangle?)"/>
+        /// <seealso cref="Fill(MediaVisionSource)"/>
+        /// <seealso cref="Fill(MediaVisionSource, ImageFillConfiguration)"/>
+        /// <seealso cref="Fill(MediaVisionSource, Rectangle)"/>
+        /// <seealso cref="Fill(MediaVisionSource, ImageFillConfiguration, Rectangle)"/>
+        /// <since_tizen> 3 </since_tizen>
         public double RecognitionRate
         {
             get
             {
-                double rate = 0;
-                InteropImage.GetRecognitionRate(Handle, out rate).Validate("Failed to get recognition rate");
+                InteropImage.GetRecognitionRate(Handle, out var rate).Validate("Failed to get recognition rate");
                 return rate;
             }
         }
@@ -96,14 +102,14 @@ namespace Tizen.Multimedia
         /// Gets the label for the image object.
         /// </summary>
         /// <returns>
-        /// The label value; or null if the <see cref="ImageObject"/> has no label.
+        /// The label value if the <see cref="ImageObject"/> has label, otherwise null.
         /// </returns>
         /// <exception cref="ObjectDisposedException">The <see cref="ImageObject"/> has already been disposed of.</exception>
         /// <seealso cref="SetLabel(int)"/>
+        /// <since_tizen> 3 </since_tizen>
         public int? GetLabel()
         {
-            int label = 0;
-            var ret = InteropImage.GetLabel(Handle, out label);
+            var ret = InteropImage.GetLabel(Handle, out var label);
 
             if (ret == MediaVisionError.NoData)
             {
@@ -118,6 +124,7 @@ namespace Tizen.Multimedia
         /// Sets the label for the <see cref="ImageObject"/>.
         /// </summary>
         /// <seealso cref="GetLabel"/>
+        /// <since_tizen> 3 </since_tizen>
         public void SetLabel(int label)
         {
             InteropImage.SetLabel(Handle, label).Validate("Failed to set label");
@@ -131,9 +138,10 @@ namespace Tizen.Multimedia
         /// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
         /// <exception cref="ObjectDisposedException">
         ///     The <see cref="ImageObject"/> has already been disposed of.\n
-        ///     - or -\n
+        ///     -or-\n
         ///     <paramref name="source"/> has already been disposed of.
         /// </exception>
+        /// <since_tizen> 3 </since_tizen>
         public void Fill(MediaVisionSource source)
         {
             InvokeFill(source, null, null);
@@ -148,11 +156,12 @@ namespace Tizen.Multimedia
         /// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
         /// <exception cref="ObjectDisposedException">
         ///     The <see cref="ImageObject"/> has already been disposed of.\n
-        ///     - or -\n
+        ///     -or-\n
         ///     <paramref name="source"/> has already been disposed of.\n
-        ///     - or -\n
+        ///     -or-\n
         ///     <paramref name="config"/> has already been disposed of.
         /// </exception>
+        /// <since_tizen> 3 </since_tizen>
         public void Fill(MediaVisionSource source, ImageFillConfiguration config)
         {
             InvokeFill(source, config, null);
@@ -167,9 +176,10 @@ namespace Tizen.Multimedia
         /// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
         /// <exception cref="ObjectDisposedException">
         ///     The <see cref="ImageObject"/> has already been disposed of.\n
-        ///     - or -\n
+        ///     -or-\n
         ///     <paramref name="source"/> has already been disposed of.\n
         /// </exception>
+        /// <since_tizen> 3 </since_tizen>
         public void Fill(MediaVisionSource source, Rectangle rect)
         {
             InvokeFill(source, null, rect);
@@ -185,11 +195,12 @@ namespace Tizen.Multimedia
         /// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
         /// <exception cref="ObjectDisposedException">
         ///     The <see cref="ImageObject"/> has already been disposed of.\n
-        ///     - or -\n
+        ///     -or-\n
         ///     <paramref name="source"/> has already been disposed of.\n
-        ///     - or -\n
+        ///     -or-\n
         ///     <paramref name="config"/> has already been disposed of.
         /// </exception>
+        /// <since_tizen> 3 </since_tizen>
         public void Fill(MediaVisionSource source, ImageFillConfiguration config, Rectangle rect)
         {
             InvokeFill(source, config, rect);
@@ -226,6 +237,7 @@ namespace Tizen.Multimedia
         /// <exception cref="UnauthorizedAccessException">No permission to write to the specified path.</exception>
         /// <exception cref="ObjectDisposedException">The <see cref="FaceRecognitionModel"/> has already been disposed of.</exception>
         /// <exception cref="DirectoryNotFoundException">The directory for <paramref name="path"/> does not exist.</exception>
+        /// <since_tizen> 3 </since_tizen>
         public void Save(string path)
         {
             if (path == null)
@@ -245,12 +257,22 @@ namespace Tizen.Multimedia
         #endregion
 
         #region IDisposable-support
+
+        /// <summary>
+        /// Releases all the 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; otherwise false to release only unmanaged resources.
+        /// </param>
         protected virtual void Dispose(bool disposing)
         {
             if (_disposed)