[Camera] Update description 51/148651/3
authorHaesu Gwon <haesu.gwon@samsung.com>
Fri, 8 Sep 2017 08:11:40 +0000 (17:11 +0900)
committerHaesu Gwon <haesu.gwon@samsung.com>
Wed, 13 Sep 2017 08:08:12 +0000 (17:08 +0900)
Change-Id: I954750802af58d9c53439acbd73468fc14e5e6ef
Signed-off-by: Haesu Gwon <haesu.gwon@samsung.com>
24 files changed:
src/Tizen.Multimedia.Camera/Camera/Camera.cs
src/Tizen.Multimedia.Camera/Camera/CameraCapturingEventArgs.cs
src/Tizen.Multimedia.Camera/Camera/CameraDeviceStateChangedEventArgs.cs
src/Tizen.Multimedia.Camera/Camera/CameraDisplaySettings.cs
src/Tizen.Multimedia.Camera/Camera/CameraErrorOccurredEventArgs.cs
src/Tizen.Multimedia.Camera/Camera/CameraException.cs [changed mode: 0644->0755]
src/Tizen.Multimedia.Camera/Camera/CameraFocusStateChangedEventArgs.cs
src/Tizen.Multimedia.Camera/Camera/CameraInterruptStartedEventArgs.cs
src/Tizen.Multimedia.Camera/Camera/CameraInterruptedEventArgs.cs
src/Tizen.Multimedia.Camera/Camera/CameraSettings.cs
src/Tizen.Multimedia.Camera/Camera/CameraStateChangedEventArgs.cs
src/Tizen.Multimedia.Camera/Camera/DoublePlane.cs
src/Tizen.Multimedia.Camera/Camera/EncodedPlane.cs
src/Tizen.Multimedia.Camera/Camera/FaceDetectedEventArgs.cs
src/Tizen.Multimedia.Camera/Camera/FaceDetectionData.cs
src/Tizen.Multimedia.Camera/Camera/HdrCaptureProgressEventArgs.cs
src/Tizen.Multimedia.Camera/Camera/IPreviewPlane.cs
src/Tizen.Multimedia.Camera/Camera/Location.cs [changed mode: 0644->0755]
src/Tizen.Multimedia.Camera/Camera/MediaPacketPreviewEventArgs.cs
src/Tizen.Multimedia.Camera/Camera/PreviewEventArgs.cs
src/Tizen.Multimedia.Camera/Camera/PreviewFrame.cs
src/Tizen.Multimedia.Camera/Camera/SinglePlane.cs
src/Tizen.Multimedia.Camera/Camera/TriplePlane.cs
src/Tizen.Multimedia.Recorder/Recorder/RecorderInterruptedEventArgs.cs

index 58477cf601d8f45c3ca939d3a868d9b35701c359..91f6c645c4f558d0f661f199add8bf8032e63389 100755 (executable)
@@ -1005,4 +1005,3 @@ namespace Tizen.Multimedia
         #endregion Callback registrations
     }
 }
-
index 4b92096deb8629bfda878a7022abb883440cf479..befb01257757c248363809a3477c9fce16263ea5 100755 (executable)
@@ -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; }
     }
 }
-
index 22704365e020a0019ce8dbf4c75bca5586a606d7..b647736b5576b4b95bfd4a9d32ced9d3e98f6caf 100755 (executable)
@@ -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; }
     }
 }
-
index eeddd8786647af153c929de962b056334d04357d..3f90093dbb8e1e79180153019b938ce4f4dead3c 100755 (executable)
@@ -173,4 +173,3 @@ namespace Tizen.Multimedia
         }
     }
 }
-
index de2032c5f350d2f9df71418295abfa01489bc2e2..650288e43a78314d868f44d2835b77110263839f 100755 (executable)
@@ -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; }
     }
 }
-
old mode 100644 (file)
new mode 100755 (executable)
index 36f46d7..40d2a70
@@ -50,4 +50,4 @@ namespace Tizen.Multimedia
         {
         }
     }
-}
\ No newline at end of file
+}
index 9826506feb562002a6b38fb9512c4ce3ef86bb41..63931d466969deb2ca74c6d34302e3567a6c9dee 100755 (executable)
@@ -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; }
     }
 }
-
index 626e4659051bc2bc3da1898fce4d7e81719b462b..ec969cf5526a68d4b520a9977ba763e4285d17ae 100755 (executable)
@@ -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; }
     }
 }
-
index 664f159e6100fcc3230c713c7eb03cf88d34b25b..ec2d277c7d28a7ad98f28b7be92290b482025c07 100755 (executable)
@@ -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; }
     }
 }
-
index e42ee1f3b095fc5d6c76cf0f8deb9eaca5941a5e..903f17ccd0245f6a931b5e2a3f61e318bd177005 100755 (executable)
@@ -1159,4 +1159,3 @@ namespace Tizen.Multimedia
         #endregion EXIF tag
     }
 }
-
index 0839688cf60cf5e61ad685fbd9b842f32fb4ba30..57f872211f3394f04caf6acdb76a72f7a16aec44 100755 (executable)
@@ -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; }
     }
 }
-
index e6960f17072795501f5ca7db939230b33b02b205..887388a40909fb1174f315773ed82c488c17500a 100755 (executable)
@@ -44,4 +44,4 @@ namespace Tizen.Multimedia
         /// <since_tizen> 3 </since_tizen>
         public byte[] UV { get; }
     }
-}
\ No newline at end of file
+}
index f1620fb462a641f3ea8cfdadf75c1f0d955a5fb0..48524b7f5847941735d4b308e8daa1e4f8f9183e 100755 (executable)
@@ -36,4 +36,4 @@ namespace Tizen.Multimedia
         /// <since_tizen> 3 </since_tizen>
         public byte[] Data { get; }
     }
-}
\ No newline at end of file
+}
index 821a0ad13d4e36a3683efa165f37288a2c640e3f..3b9e7eb878d704a0da0641138565cff0f8393fae 100755 (executable)
@@ -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; }
     }
 }
-
index 97b8712ccad217a525fac95817935846136bfd35..0a3f6c0d9202b11521ce845d610a4a33266602fb 100755 (executable)
@@ -74,4 +74,3 @@ namespace Tizen.Multimedia
         public int Height { get; }
     }
 }
-
index 61ba45bd7797ec7933e0ac79938b0737a433bbf9..cf447656ec1b03d5bb1e051be5dd28ac976dfbf6 100755 (executable)
@@ -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; }
     }
 }
-
index e3b506bbdb406586614328254510043aaca5e1a9..d84d07a196cc21404f5e9e447a0ecbdcf67f5b15 100755 (executable)
@@ -19,4 +19,4 @@ namespace Tizen.Multimedia
     public interface IPreviewPlane
     {
     }
-}
\ No newline at end of file
+}
old mode 100644 (file)
new mode 100755 (executable)
index 71c427a..8160f4e
@@ -53,4 +53,3 @@ namespace Tizen.Multimedia
         public double Altitude { get; }
     }
 }
-
index 3ef9684c54b07762e0fc95b77808e42a592f9e8d..b60083b906da9bd30d7d7e4cfaaa13718d15cc76 100755 (executable)
@@ -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; }
     }
 }
-
index 28cce5157f0e779911aa5b6eecd6129562e9f241..fbda63cb1f157154a8024ac0ab5e20b55973adb4 100755 (executable)
@@ -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; }
     }
 }
-
index 04962efd82fe8ee68ebe18a1d07251e5a82328e3..37770181c0bdacc0288a9c4b0305c1029e380491 100755 (executable)
@@ -114,4 +114,4 @@ namespace Tizen.Multimedia
         /// <since_tizen> 3 </since_tizen>
         public IPreviewPlane Plane { get; }
     }
-}
\ No newline at end of file
+}
index 96710902607214b0e6319c4259fcad3c92fc5f57..d627c5d03de2694dc0ac58b24b478b8b1d61e19b 100755 (executable)
@@ -36,4 +36,4 @@ namespace Tizen.Multimedia
         /// <since_tizen> 3 </since_tizen>
         public byte[] Data { get; }
     }
-}
\ No newline at end of file
+}
index 132911bcb5066afbc6be32eb3c6433f5d4c630a6..0d50515279b8f2a77a8752d1b8754ee0c7a64d61 100755 (executable)
@@ -52,4 +52,4 @@ namespace Tizen.Multimedia
         /// <since_tizen> 3 </since_tizen>
         public byte[] V { get; }
     }
-}
\ No newline at end of file
+}
index 86be7130d862e2400b8d8b2e95810c2e3e0562ca..cae132986da123e71989eff1d30cc2499301c4bd 100755 (executable)
@@ -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; }