From: Haesu Gwon <haesu.gwon@samsung.com>
Date: Fri, 8 Sep 2017 08:11:40 +0000 (+0900)
Subject: [Camera] Update description
X-Git-Tag: preview1-00199~9
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=eec6ed44610d17bfa09441c1502d67d5b6dadc1c;p=platform%2Fcore%2Fcsapi%2Ftizenfx.git

[Camera] Update description

Change-Id: I954750802af58d9c53439acbd73468fc14e5e6ef
Signed-off-by: Haesu Gwon <haesu.gwon@samsung.com>
---

diff --git a/src/Tizen.Multimedia.Camera/Camera/Camera.cs b/src/Tizen.Multimedia.Camera/Camera/Camera.cs
index 58477cf60..91f6c645c 100755
--- a/src/Tizen.Multimedia.Camera/Camera/Camera.cs
+++ b/src/Tizen.Multimedia.Camera/Camera/Camera.cs
@@ -1005,4 +1005,3 @@ namespace Tizen.Multimedia
         #endregion Callback registrations
     }
 }
-
diff --git a/src/Tizen.Multimedia.Camera/Camera/CameraCapturingEventArgs.cs b/src/Tizen.Multimedia.Camera/Camera/CameraCapturingEventArgs.cs
index 4b92096de..befb01257 100755
--- a/src/Tizen.Multimedia.Camera/Camera/CameraCapturingEventArgs.cs
+++ b/src/Tizen.Multimedia.Camera/Camera/CameraCapturingEventArgs.cs
@@ -19,7 +19,7 @@ using System;
 namespace Tizen.Multimedia
 {
     /// <summary>
-    /// An extended EventArgs class which contains details about the captured still image.
+    /// Provides data for the <see cref="Camera.Capturing"/> event.
     /// </summary>
     public class CameraCapturingEventArgs : EventArgs
     {
@@ -31,22 +31,21 @@ namespace Tizen.Multimedia
         }
 
         /// <summary>
-        /// The main image data of the captured still image.
+        /// Gets the main image data of the captured still image.
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         public StillImage MainImage { get; }
 
         /// <summary>
-        /// The image data of the post view.
+        /// Gets the image data of the post view.
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         public StillImage PostView { get; }
 
         /// <summary>
-        /// The image data of the thumbnail.
+        /// Gets the image data of the thumbnail.
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         public StillImage Thumbnail { get; }
     }
 }
-
diff --git a/src/Tizen.Multimedia.Camera/Camera/CameraDeviceStateChangedEventArgs.cs b/src/Tizen.Multimedia.Camera/Camera/CameraDeviceStateChangedEventArgs.cs
index 22704365e..b647736b5 100755
--- a/src/Tizen.Multimedia.Camera/Camera/CameraDeviceStateChangedEventArgs.cs
+++ b/src/Tizen.Multimedia.Camera/Camera/CameraDeviceStateChangedEventArgs.cs
@@ -19,8 +19,7 @@ using System;
 namespace Tizen.Multimedia
 {
     /// <summary>
-    /// An extended EventArgs class which contains details about the previous and the current state
-    /// of the camera when its state is changed.
+    /// Provides data for the <see cref="Camera.DeviceStateChanged"/> event.
     /// </summary>
     public class CameraDeviceStateChangedEventArgs : EventArgs
     {
@@ -31,16 +30,15 @@ namespace Tizen.Multimedia
         }
 
         /// <summary>
-        /// The camera device type.
+        /// Gets the camera device type.
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         public CameraDevice Device { get; }
 
         /// <summary>
-        /// The current state of the camera device.
+        /// Gets the current state of the camera device.
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         public CameraDeviceState State { get; }
     }
 }
-
diff --git a/src/Tizen.Multimedia.Camera/Camera/CameraDisplaySettings.cs b/src/Tizen.Multimedia.Camera/Camera/CameraDisplaySettings.cs
index eeddd8786..3f90093db 100755
--- a/src/Tizen.Multimedia.Camera/Camera/CameraDisplaySettings.cs
+++ b/src/Tizen.Multimedia.Camera/Camera/CameraDisplaySettings.cs
@@ -173,4 +173,3 @@ namespace Tizen.Multimedia
         }
     }
 }
-
diff --git a/src/Tizen.Multimedia.Camera/Camera/CameraErrorOccurredEventArgs.cs b/src/Tizen.Multimedia.Camera/Camera/CameraErrorOccurredEventArgs.cs
index de2032c5f..650288e43 100755
--- a/src/Tizen.Multimedia.Camera/Camera/CameraErrorOccurredEventArgs.cs
+++ b/src/Tizen.Multimedia.Camera/Camera/CameraErrorOccurredEventArgs.cs
@@ -19,8 +19,7 @@ using System;
 namespace Tizen.Multimedia
 {
     /// <summary>
-    /// An extended EventArgs class which contains details about the error status and the
-    /// state of the camera when it fails.
+    /// Provides data for the <see cref="Camera.ErrorOccurred"/> event.
     /// </summary>
     public class CameraErrorOccurredEventArgs : EventArgs
     {
@@ -31,16 +30,15 @@ namespace Tizen.Multimedia
         }
 
         /// <summary>
-        /// The camera error code.
+        /// Gets the camera error.
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         public CameraErrorCode Error { get; }
 
         /// <summary>
-        /// The state of the camera.
+        /// Gets the current state of the camera.
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         public CameraState State { get; }
     }
 }
-
diff --git a/src/Tizen.Multimedia.Camera/Camera/CameraException.cs b/src/Tizen.Multimedia.Camera/Camera/CameraException.cs
old mode 100644
new mode 100755
index 36f46d79d..40d2a701f
--- a/src/Tizen.Multimedia.Camera/Camera/CameraException.cs
+++ b/src/Tizen.Multimedia.Camera/Camera/CameraException.cs
@@ -50,4 +50,4 @@ namespace Tizen.Multimedia
         {
         }
     }
-}
\ No newline at end of file
+}
diff --git a/src/Tizen.Multimedia.Camera/Camera/CameraFocusStateChangedEventArgs.cs b/src/Tizen.Multimedia.Camera/Camera/CameraFocusStateChangedEventArgs.cs
index 9826506fe..63931d466 100755
--- a/src/Tizen.Multimedia.Camera/Camera/CameraFocusStateChangedEventArgs.cs
+++ b/src/Tizen.Multimedia.Camera/Camera/CameraFocusStateChangedEventArgs.cs
@@ -19,7 +19,7 @@ using System;
 namespace Tizen.Multimedia
 {
     /// <summary>
-    /// An extended EventArgs class which contains details about the focus state of the camera.
+    /// Provides data for the <see cref="Camera.FocusStateChanged"/> event.
     /// </summary>
     public class CameraFocusStateChangedEventArgs : EventArgs
     {
@@ -29,10 +29,9 @@ namespace Tizen.Multimedia
         }
 
         /// <summary>
-        /// The focus state of the camera.
+        /// Gets the focus state of the camera.
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         public CameraFocusState State { get; }
     }
 }
-
diff --git a/src/Tizen.Multimedia.Camera/Camera/CameraInterruptStartedEventArgs.cs b/src/Tizen.Multimedia.Camera/Camera/CameraInterruptStartedEventArgs.cs
index 626e46590..ec969cf55 100755
--- a/src/Tizen.Multimedia.Camera/Camera/CameraInterruptStartedEventArgs.cs
+++ b/src/Tizen.Multimedia.Camera/Camera/CameraInterruptStartedEventArgs.cs
@@ -19,8 +19,7 @@ using System;
 namespace Tizen.Multimedia
 {
     /// <summary>
-    /// An extended EventArgs class which contains details about current state
-    /// of the camera when interrupt is invoked internally in Native FW.
+    /// Provides data for the <see cref="Camera.InterruptStarted"/> event.
     /// </summary>
     public class CameraInterruptStartedEventArgs : EventArgs
     {
@@ -31,14 +30,13 @@ namespace Tizen.Multimedia
         }
 
         /// <summary>
-        /// Current state of the camera.
+        /// Gets the current state of the camera.
         /// </summary>
         public CameraState State { get; }
 
         /// <summary>
-        /// The policy that interrupted the camera.
+        /// Gets the policy that interrupted the camera.
         /// </summary>
         public CameraPolicy Policy { get; }
     }
 }
-
diff --git a/src/Tizen.Multimedia.Camera/Camera/CameraInterruptedEventArgs.cs b/src/Tizen.Multimedia.Camera/Camera/CameraInterruptedEventArgs.cs
index 664f159e6..ec2d277c7 100755
--- a/src/Tizen.Multimedia.Camera/Camera/CameraInterruptedEventArgs.cs
+++ b/src/Tizen.Multimedia.Camera/Camera/CameraInterruptedEventArgs.cs
@@ -19,8 +19,7 @@ using System;
 namespace Tizen.Multimedia
 {
     /// <summary>
-    /// An extended EventArgs class which contains details about the previous and the current state
-    /// of the camera when it is interrupted.
+    /// Provides data for the <see cref="Camera.Interrupted"/> event.
     /// </summary>
     public class CameraInterruptedEventArgs : EventArgs
     {
@@ -32,22 +31,21 @@ namespace Tizen.Multimedia
         }
 
         /// <summary>
-        /// The previous state of the camera.
+        /// Gets the previous state of the camera.
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         public CameraState Previous { get; }
 
         /// <summary>
-        /// The current state of the camera.
+        /// Gets the current state of the camera.
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         public CameraState Current { get; }
 
         /// <summary>
-        /// The policy that interrupted the camera.
+        /// Gets the policy that interrupted the camera.
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         public CameraPolicy Policy { get; }
     }
 }
-
diff --git a/src/Tizen.Multimedia.Camera/Camera/CameraSettings.cs b/src/Tizen.Multimedia.Camera/Camera/CameraSettings.cs
index e42ee1f3b..903f17ccd 100755
--- a/src/Tizen.Multimedia.Camera/Camera/CameraSettings.cs
+++ b/src/Tizen.Multimedia.Camera/Camera/CameraSettings.cs
@@ -1159,4 +1159,3 @@ namespace Tizen.Multimedia
         #endregion EXIF tag
     }
 }
-
diff --git a/src/Tizen.Multimedia.Camera/Camera/CameraStateChangedEventArgs.cs b/src/Tizen.Multimedia.Camera/Camera/CameraStateChangedEventArgs.cs
index 0839688cf..57f872211 100755
--- a/src/Tizen.Multimedia.Camera/Camera/CameraStateChangedEventArgs.cs
+++ b/src/Tizen.Multimedia.Camera/Camera/CameraStateChangedEventArgs.cs
@@ -19,8 +19,7 @@ using System;
 namespace Tizen.Multimedia
 {
     /// <summary>
-    /// An extended EventArgs class which contains details about the previous and the current state
-    /// of the camera when its state is changed.
+    /// Provides data for the <see cref="Camera.StateChanged"/> event.
     /// </summary>
     public class CameraStateChangedEventArgs : EventArgs
     {
@@ -47,10 +46,9 @@ namespace Tizen.Multimedia
         /// Gets the value indicating whether the state is changed by policy.
         /// </summary>
         /// <value>
-        /// true if the state changed by policy such as resource conflict or security, otherwise false.
+        /// true if the state changed by policy, such as resource conflict or security, otherwise false.
         /// </value>
         /// <since_tizen> 3 </since_tizen>
         public bool ByPolicy { get; }
     }
 }
-
diff --git a/src/Tizen.Multimedia.Camera/Camera/DoublePlane.cs b/src/Tizen.Multimedia.Camera/Camera/DoublePlane.cs
index e6960f170..887388a40 100755
--- a/src/Tizen.Multimedia.Camera/Camera/DoublePlane.cs
+++ b/src/Tizen.Multimedia.Camera/Camera/DoublePlane.cs
@@ -44,4 +44,4 @@ namespace Tizen.Multimedia
         /// <since_tizen> 3 </since_tizen>
         public byte[] UV { get; }
     }
-}
\ No newline at end of file
+}
diff --git a/src/Tizen.Multimedia.Camera/Camera/EncodedPlane.cs b/src/Tizen.Multimedia.Camera/Camera/EncodedPlane.cs
index f1620fb46..48524b7f5 100755
--- a/src/Tizen.Multimedia.Camera/Camera/EncodedPlane.cs
+++ b/src/Tizen.Multimedia.Camera/Camera/EncodedPlane.cs
@@ -36,4 +36,4 @@ namespace Tizen.Multimedia
         /// <since_tizen> 3 </since_tizen>
         public byte[] Data { get; }
     }
-}
\ No newline at end of file
+}
diff --git a/src/Tizen.Multimedia.Camera/Camera/FaceDetectedEventArgs.cs b/src/Tizen.Multimedia.Camera/Camera/FaceDetectedEventArgs.cs
index 821a0ad13..3b9e7eb87 100755
--- a/src/Tizen.Multimedia.Camera/Camera/FaceDetectedEventArgs.cs
+++ b/src/Tizen.Multimedia.Camera/Camera/FaceDetectedEventArgs.cs
@@ -20,7 +20,7 @@ using System.Collections.Generic;
 namespace Tizen.Multimedia
 {
     /// <summary>
-    /// An extended EventArgs class which contains details about all the faces detected.
+    /// Provides data for the <see cref="Camera.FaceDetected"/> event.
     /// If the user needs to keep the faces data, the user has to copy the data.
     /// </summary>
     public class FaceDetectedEventArgs : EventArgs
@@ -31,10 +31,9 @@ namespace Tizen.Multimedia
         }
 
         /// <summary>
-        /// The list containing faces of type <see cref="Tizen.Multimedia.FaceDetectionData"/>.
+        /// Gets the list containing faces of type <see cref="Tizen.Multimedia.FaceDetectionData"/>.
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         public IEnumerable<FaceDetectionData> Faces { get; }
     }
 }
-
diff --git a/src/Tizen.Multimedia.Camera/Camera/FaceDetectionData.cs b/src/Tizen.Multimedia.Camera/Camera/FaceDetectionData.cs
index 97b8712cc..0a3f6c0d9 100755
--- a/src/Tizen.Multimedia.Camera/Camera/FaceDetectionData.cs
+++ b/src/Tizen.Multimedia.Camera/Camera/FaceDetectionData.cs
@@ -74,4 +74,3 @@ namespace Tizen.Multimedia
         public int Height { get; }
     }
 }
-
diff --git a/src/Tizen.Multimedia.Camera/Camera/HdrCaptureProgressEventArgs.cs b/src/Tizen.Multimedia.Camera/Camera/HdrCaptureProgressEventArgs.cs
index 61ba45bd7..cf447656e 100755
--- a/src/Tizen.Multimedia.Camera/Camera/HdrCaptureProgressEventArgs.cs
+++ b/src/Tizen.Multimedia.Camera/Camera/HdrCaptureProgressEventArgs.cs
@@ -19,7 +19,7 @@ using System;
 namespace Tizen.Multimedia
 {
     /// <summary>
-    /// An extended EventArgs class which contains details about the HDR capture progress.
+    /// Provides data for the <see cref="Camera.HdrCaptureProgress"/> event.
     /// </summary>
     public class HdrCaptureProgressEventArgs : EventArgs
     {
@@ -29,10 +29,9 @@ namespace Tizen.Multimedia
         }
 
         /// <summary>
-        /// The HDR capture progress in percent.
+        /// Gets the HDR Capture progress in percent.
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         public int Percent { get; }
     }
 }
-
diff --git a/src/Tizen.Multimedia.Camera/Camera/IPreviewPlane.cs b/src/Tizen.Multimedia.Camera/Camera/IPreviewPlane.cs
index e3b506bbd..d84d07a19 100755
--- a/src/Tizen.Multimedia.Camera/Camera/IPreviewPlane.cs
+++ b/src/Tizen.Multimedia.Camera/Camera/IPreviewPlane.cs
@@ -19,4 +19,4 @@ namespace Tizen.Multimedia
     public interface IPreviewPlane
     {
     }
-}
\ No newline at end of file
+}
diff --git a/src/Tizen.Multimedia.Camera/Camera/Location.cs b/src/Tizen.Multimedia.Camera/Camera/Location.cs
old mode 100644
new mode 100755
index 71c427aae..8160f4e92
--- a/src/Tizen.Multimedia.Camera/Camera/Location.cs
+++ b/src/Tizen.Multimedia.Camera/Camera/Location.cs
@@ -53,4 +53,3 @@ namespace Tizen.Multimedia
         public double Altitude { get; }
     }
 }
-
diff --git a/src/Tizen.Multimedia.Camera/Camera/MediaPacketPreviewEventArgs.cs b/src/Tizen.Multimedia.Camera/Camera/MediaPacketPreviewEventArgs.cs
index 3ef9684c5..b60083b90 100755
--- a/src/Tizen.Multimedia.Camera/Camera/MediaPacketPreviewEventArgs.cs
+++ b/src/Tizen.Multimedia.Camera/Camera/MediaPacketPreviewEventArgs.cs
@@ -19,7 +19,7 @@ using System;
 namespace Tizen.Multimedia
 {
     /// <summary>
-    /// An extended EventArgs class which contains details about the media packet preview frame.
+    /// Provides data for the <see cref="Camera.MediaPacketPreview"/> event.
     /// </summary>
     public class MediaPacketPreviewEventArgs : EventArgs
     {
@@ -29,10 +29,9 @@ namespace Tizen.Multimedia
         }
 
         /// <summary>
-        /// The media packet data.
+        /// Gets the media packet data.
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         public MediaPacket Packet { get; }
     }
 }
-
diff --git a/src/Tizen.Multimedia.Camera/Camera/PreviewEventArgs.cs b/src/Tizen.Multimedia.Camera/Camera/PreviewEventArgs.cs
index 28cce5157..fbda63cb1 100755
--- a/src/Tizen.Multimedia.Camera/Camera/PreviewEventArgs.cs
+++ b/src/Tizen.Multimedia.Camera/Camera/PreviewEventArgs.cs
@@ -19,7 +19,7 @@ using System;
 namespace Tizen.Multimedia
 {
     /// <summary>
-    /// An extended EventArgs class which contains details about the preview frame.
+    /// Provides data for the <see cref="Camera.Preview"/> event.
     /// </summary>
     public class PreviewEventArgs : EventArgs
     {
@@ -29,10 +29,9 @@ namespace Tizen.Multimedia
         }
 
         /// <summary>
-        /// The PreviewData frame.
+        /// Gets the preview frame data.
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
         public PreviewFrame Preview { get; }
     }
 }
-
diff --git a/src/Tizen.Multimedia.Camera/Camera/PreviewFrame.cs b/src/Tizen.Multimedia.Camera/Camera/PreviewFrame.cs
index 04962efd8..37770181c 100755
--- a/src/Tizen.Multimedia.Camera/Camera/PreviewFrame.cs
+++ b/src/Tizen.Multimedia.Camera/Camera/PreviewFrame.cs
@@ -114,4 +114,4 @@ namespace Tizen.Multimedia
         /// <since_tizen> 3 </since_tizen>
         public IPreviewPlane Plane { get; }
     }
-}
\ No newline at end of file
+}
diff --git a/src/Tizen.Multimedia.Camera/Camera/SinglePlane.cs b/src/Tizen.Multimedia.Camera/Camera/SinglePlane.cs
index 967109026..d627c5d03 100755
--- a/src/Tizen.Multimedia.Camera/Camera/SinglePlane.cs
+++ b/src/Tizen.Multimedia.Camera/Camera/SinglePlane.cs
@@ -36,4 +36,4 @@ namespace Tizen.Multimedia
         /// <since_tizen> 3 </since_tizen>
         public byte[] Data { get; }
     }
-}
\ No newline at end of file
+}
diff --git a/src/Tizen.Multimedia.Camera/Camera/TriplePlane.cs b/src/Tizen.Multimedia.Camera/Camera/TriplePlane.cs
index 132911bcb..0d5051527 100755
--- a/src/Tizen.Multimedia.Camera/Camera/TriplePlane.cs
+++ b/src/Tizen.Multimedia.Camera/Camera/TriplePlane.cs
@@ -52,4 +52,4 @@ namespace Tizen.Multimedia
         /// <since_tizen> 3 </since_tizen>
         public byte[] V { get; }
     }
-}
\ No newline at end of file
+}
diff --git a/src/Tizen.Multimedia.Recorder/Recorder/RecorderInterruptedEventArgs.cs b/src/Tizen.Multimedia.Recorder/Recorder/RecorderInterruptedEventArgs.cs
index 86be7130d..cae132986 100755
--- a/src/Tizen.Multimedia.Recorder/Recorder/RecorderInterruptedEventArgs.cs
+++ b/src/Tizen.Multimedia.Recorder/Recorder/RecorderInterruptedEventArgs.cs
@@ -31,7 +31,7 @@ namespace Tizen.Multimedia
         }
 
         /// <summary>
-        /// Gets the policy that interrupted the recorder.
+        /// Gets the reason that interrupted the recorder.
         /// </summary>
         public RecorderPolicy Reason { get; }