From: Haesu Gwon Date: Fri, 8 Sep 2017 02:48:32 +0000 (+0900) Subject: [Vision] Update descriptions to fix ths grammer errors. X-Git-Tag: preview1-00174^2 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=008c6bb1d75c2f8088866426b4a64d430bf06afa;p=platform%2Fcore%2Fcsapi%2Ftizenfx.git [Vision] Update descriptions to fix ths grammer errors. - Reviewed by Lionbridge. Change-Id: I2bb2f3d7c726278a9759db42f2cc9ed766599369 Signed-off-by: Haesu Gwon --- diff --git a/src/Tizen.Multimedia.Vision/Interop/Interop.MediaVision.BarCode.cs b/src/Tizen.Multimedia.Vision/Interop/Interop.MediaVision.BarCode.cs index b82df445b..0d7d134b4 100644 --- a/src/Tizen.Multimedia.Vision/Interop/Interop.MediaVision.BarCode.cs +++ b/src/Tizen.Multimedia.Vision/Interop/Interop.MediaVision.BarCode.cs @@ -19,17 +19,17 @@ using System.Runtime.InteropServices; using Tizen.Multimedia.Vision; /// -/// Interop APIs +/// Interop APIs. /// internal static partial class Interop { /// - /// Interop for media vision APIs + /// Interop for Media Vision APIs. /// internal static partial class MediaVision { /// - /// Interop for barcode detector APIs + /// Interop for Barcode Detector APIs. /// internal static partial class BarcodeDetector { @@ -51,7 +51,7 @@ internal static partial class Interop } /// - /// Interop for barcode generator APIs + /// Interop for Barcode Generator APIs. /// internal static partial class BarcodeGenerator { diff --git a/src/Tizen.Multimedia.Vision/Interop/Interop.MediaVision.Common.cs b/src/Tizen.Multimedia.Vision/Interop/Interop.MediaVision.Common.cs old mode 100644 new mode 100755 index 25df35d2d..37623220f --- a/src/Tizen.Multimedia.Vision/Interop/Interop.MediaVision.Common.cs +++ b/src/Tizen.Multimedia.Vision/Interop/Interop.MediaVision.Common.cs @@ -19,7 +19,7 @@ using System.Runtime.InteropServices; using Tizen.Multimedia.Vision; /// -/// Interop APIs +/// Interop APIs. /// internal static partial class Interop { @@ -92,7 +92,7 @@ internal static partial class Interop } /// - /// Interop for media vision APIs + /// Interop for Media Vision APIs. /// internal static partial class MediaVision { @@ -120,7 +120,7 @@ internal static partial class Interop } /// - /// Interop for media vision source APIs + /// Interop for Media Vision Source APIs. /// internal static partial class MediaSource { @@ -154,7 +154,7 @@ internal static partial class Interop } /// - /// Interop for engine configuration APIs + /// Interop for Engine Configuration APIs. /// internal static partial class EngineConfig { diff --git a/src/Tizen.Multimedia.Vision/Interop/Interop.MediaVision.Face.cs b/src/Tizen.Multimedia.Vision/Interop/Interop.MediaVision.Face.cs old mode 100644 new mode 100755 index 9e0429e78..8ce61f838 --- a/src/Tizen.Multimedia.Vision/Interop/Interop.MediaVision.Face.cs +++ b/src/Tizen.Multimedia.Vision/Interop/Interop.MediaVision.Face.cs @@ -19,17 +19,17 @@ using System.Runtime.InteropServices; using Tizen.Multimedia.Vision; /// -/// Interop APIs +/// Interop APIs. /// internal static partial class Interop { /// - /// Interop for media vision APIs + /// Interop for Media Vision APIs. /// internal static partial class MediaVision { /// - /// Interop for Face APIs + /// Interop for Face APIs. /// internal static partial class Face { @@ -81,7 +81,7 @@ internal static partial class Interop } /// - /// Interop for FaceRecognitionModel APIs + /// Interop for FaceRecognitionModel APIs. /// internal static partial class FaceRecognitionModel { @@ -122,7 +122,7 @@ internal static partial class Interop } /// - /// Interop for FaceTrackingModel APIs + /// Interop for FaceTrackingModel APIs. /// internal static partial class FaceTrackingModel { diff --git a/src/Tizen.Multimedia.Vision/Interop/Interop.MediaVision.Image.cs b/src/Tizen.Multimedia.Vision/Interop/Interop.MediaVision.Image.cs old mode 100644 new mode 100755 index c0c3886af..ebf59edbb --- a/src/Tizen.Multimedia.Vision/Interop/Interop.MediaVision.Image.cs +++ b/src/Tizen.Multimedia.Vision/Interop/Interop.MediaVision.Image.cs @@ -19,17 +19,17 @@ using System.Runtime.InteropServices; using Tizen.Multimedia.Vision; /// -/// Interop APIs +/// Interop APIs. /// internal static partial class Interop { /// - /// Interop for Media vision APIs + /// Interop for Media Vision APIs. /// internal static partial class MediaVision { /// - /// Interop for Image APIs + /// Interop for Image APIs. /// internal static partial class Image { @@ -82,7 +82,7 @@ internal static partial class Interop } /// - /// Interop for ImageTrackingModel APIs + /// Interop for ImageTrackingModel APIs. /// internal static partial class ImageTrackingModel { diff --git a/src/Tizen.Multimedia.Vision/Interop/Interop.MediaVision.Surveillance.cs b/src/Tizen.Multimedia.Vision/Interop/Interop.MediaVision.Surveillance.cs old mode 100644 new mode 100755 index cafffc3f5..d63c6a0c6 --- a/src/Tizen.Multimedia.Vision/Interop/Interop.MediaVision.Surveillance.cs +++ b/src/Tizen.Multimedia.Vision/Interop/Interop.MediaVision.Surveillance.cs @@ -19,17 +19,17 @@ using System.Runtime.InteropServices; using Tizen.Multimedia.Vision; /// -/// Interop APIs +/// Interop APIs. /// internal static partial class Interop { /// - /// Interop for media vision APIs + /// Interop for Media Vision APIs. /// internal static partial class MediaVision { /// - /// Interop for surveillance APIs + /// Interop for Surveillance APIs. /// internal static partial class Surveillance { diff --git a/src/Tizen.Multimedia.Vision/MediaVision/Barcode.cs b/src/Tizen.Multimedia.Vision/MediaVision/Barcode.cs index 1fece1129..a8d9ce8b0 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/Barcode.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/Barcode.cs @@ -34,19 +34,19 @@ namespace Tizen.Multimedia.Vision } /// - /// The quadrangle location of detected barcode. + /// The quadrangle location of the detected barcode. /// /// 3 public Quadrangle Region { get; } /// - /// The decoded message of barcode. + /// The decoded message of the barcode. /// /// 3 public string Message { get; } /// - /// The type of detected barcode. + /// The type of the detected barcode. /// /// 3 public BarcodeType Type { get; } diff --git a/src/Tizen.Multimedia.Vision/MediaVision/BarcodeDetectionConfiguration.cs b/src/Tizen.Multimedia.Vision/MediaVision/BarcodeDetectionConfiguration.cs index 3dd495f7c..b80cda76a 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/BarcodeDetectionConfiguration.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/BarcodeDetectionConfiguration.cs @@ -20,7 +20,7 @@ namespace Tizen.Multimedia.Vision /// Represents a configuration of . /// /// - /// 3 + /// 3 public class BarcodeDetectionConfiguration : EngineConfiguration { private const string KeyAttrTarget = "MV_BARCODE_DETECT_ATTR_TARGET"; @@ -29,7 +29,7 @@ namespace Tizen.Multimedia.Vision /// Initializes a new instance of the class. /// /// The feature is not supported. - /// 3 + /// 3 public BarcodeDetectionConfiguration() : base("barcode_detection") { } @@ -39,7 +39,7 @@ namespace Tizen.Multimedia.Vision /// /// is not valid. /// The already has been disposed of. - /// 3 + /// 3 public BarcodeDetectionTarget Target { get diff --git a/src/Tizen.Multimedia.Vision/MediaVision/BarcodeDetectionTarget.cs b/src/Tizen.Multimedia.Vision/MediaVision/BarcodeDetectionTarget.cs index 3659b983b..0da739624 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/BarcodeDetectionTarget.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/BarcodeDetectionTarget.cs @@ -19,25 +19,25 @@ namespace Tizen.Multimedia.Vision /// /// Specifies the target of . /// - /// 3 + /// 3 public enum BarcodeDetectionTarget { /// /// 1D and 2D. /// - /// 3 + /// 3 All, /// /// 1D barcode only. /// - /// 3 + /// 3 Barcode1D, /// /// 2D barcode only. /// - /// 3 + /// 3 Barcode2D, } } diff --git a/src/Tizen.Multimedia.Vision/MediaVision/BarcodeDetector.cs b/src/Tizen.Multimedia.Vision/MediaVision/BarcodeDetector.cs index 85cd90a49..176db34bd 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/BarcodeDetector.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/BarcodeDetector.cs @@ -25,11 +25,11 @@ namespace Tizen.Multimedia.Vision /// /// Provides the ability to detect barcodes on image sources. /// - /// 3 + /// 3 public static class BarcodeDetector { /// - /// Detects barcodes on source and reads message from it. + /// Detects barcodes on the source and reads the message from it. /// /// The instance. /// Region of interest - rectangular area on the source which will be used for @@ -47,7 +47,7 @@ namespace Tizen.Multimedia.Vision } /// - /// Detects barcodes on source and reads message from it with . + /// Detects barcodes on the source and reads the message from it with . /// /// The instance. /// Region of interest - rectangular area on the source which will be used for diff --git a/src/Tizen.Multimedia.Vision/MediaVision/BarcodeGenerationConfiguration.cs b/src/Tizen.Multimedia.Vision/MediaVision/BarcodeGenerationConfiguration.cs index 3be2d49de..a12adeac2 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/BarcodeGenerationConfiguration.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/BarcodeGenerationConfiguration.cs @@ -22,7 +22,7 @@ namespace Tizen.Multimedia.Vision /// Represents a configuration of instances. /// /// - /// 3 + /// 3 public class BarcodeGenerationConfiguration : EngineConfiguration { private const string KeyTextAttr = "MV_BARCODE_GENERATE_ATTR_TEXT"; @@ -33,7 +33,7 @@ namespace Tizen.Multimedia.Vision /// Initializes a new instance of the class. /// /// The feature is not supported. - /// 3 + /// 3 public BarcodeGenerationConfiguration() : base("barcode_generation") { } @@ -43,7 +43,7 @@ namespace Tizen.Multimedia.Vision /// /// is not valid. /// The already has been disposed of. - /// 3 + /// 3 public Visibility TextVisibility { get @@ -66,7 +66,7 @@ namespace Tizen.Multimedia.Vision /// The alpha value of the color will be ignored. /// /// The already has been disposed of. - /// 3 + /// 3 public Color ForegroundColor { get @@ -89,7 +89,7 @@ namespace Tizen.Multimedia.Vision /// The alpha value of the color will be ignored. /// /// The already has been disposed of. - /// 3 + /// 3 public Color BackgroundColor { get diff --git a/src/Tizen.Multimedia.Vision/MediaVision/BarcodeGenerator.cs b/src/Tizen.Multimedia.Vision/MediaVision/BarcodeGenerator.cs index 45c896ece..402a109bf 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/BarcodeGenerator.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/BarcodeGenerator.cs @@ -21,11 +21,11 @@ namespace Tizen.Multimedia.Vision { /// /// Provides the ability to generate barcodes and QR codes. - /// Different encoding types , error correction codes + /// Different encoding types , error correction codes , /// and code versions are supported for QRCodes. /// /// - /// 3 + /// 3 public static class BarcodeGenerator { private const int NoneErrorCorrection = (int)ErrorCorrectionLevel.High + 1; @@ -74,7 +74,7 @@ namespace Tizen.Multimedia.Vision /// /// The feature is not supported. /// - /// 3 + /// 3 public static MediaVisionSource GenerateSource(string message, QrConfiguration qrConfig) { return GenerateSource(message, qrConfig, null); @@ -108,7 +108,7 @@ namespace Tizen.Multimedia.Vision /// /// already has been disposed of. /// - /// 3 + /// 3 public static MediaVisionSource GenerateSource(string message, QrConfiguration qrConfig, BarcodeGenerationConfiguration config) { @@ -146,7 +146,7 @@ namespace Tizen.Multimedia.Vision /// contains illegal characters. /// /// The feature is not supported. - /// 3 + /// 3 public static MediaVisionSource GenerateSource(string message, BarcodeType type) { return GenerateSource(message, type, null); @@ -171,7 +171,7 @@ namespace Tizen.Multimedia.Vision /// /// The feature is not supported. /// already has been disposed of. - /// 3 + /// 3 public static MediaVisionSource GenerateSource(string message, BarcodeType type, BarcodeGenerationConfiguration config) { @@ -230,7 +230,7 @@ namespace Tizen.Multimedia.Vision /// No permission to write a file. /// The feature is not supported. /// - /// 3 + /// 3 public static void GenerateImage(string message, QrConfiguration qrConfig, BarcodeImageConfiguration imageConfig) { @@ -268,7 +268,7 @@ namespace Tizen.Multimedia.Vision /// is the . /// /// already has been disposed of. - /// 3 + /// 3 public static void GenerateImage(string message, QrConfiguration qrConfig, BarcodeImageConfiguration imageConfig, BarcodeGenerationConfiguration config) { @@ -312,7 +312,7 @@ namespace Tizen.Multimedia.Vision /// /// No permission to write a file. /// The feature is not supported. - /// 3 + /// 3 public static void GenerateImage(string message, BarcodeType type, BarcodeImageConfiguration imageConfig) { GenerateImage(message, type, imageConfig, null); @@ -343,7 +343,7 @@ namespace Tizen.Multimedia.Vision /// No permission to write a file. /// The feature is not supported. /// already has been disposed of. - /// 3 + /// 3 public static void GenerateImage(string message, BarcodeType type, BarcodeImageConfiguration imageConfig, BarcodeGenerationConfiguration config) { diff --git a/src/Tizen.Multimedia.Vision/MediaVision/BarcodeImageConfiguration.cs b/src/Tizen.Multimedia.Vision/MediaVision/BarcodeImageConfiguration.cs index 40588d012..bf14e4430 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/BarcodeImageConfiguration.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/BarcodeImageConfiguration.cs @@ -21,15 +21,15 @@ namespace Tizen.Multimedia.Vision /// /// Represents a configuration for the image to be generated by . /// - /// 3 + /// 3 public class BarcodeImageConfiguration { /// /// Initializes a new instance of the class. /// /// - /// The mediastorage privilege(http://tizen.org/privilege/mediastorage) is needed if image path is relevant to media storage.\n - /// The externalstorage privilege(http://tizen.org/privilege/externalstorage) is needed if image path is relevant to external storage. + /// The mediastorage privilege (http://tizen.org/privilege/mediastorage) is needed if the image path is relevant to media storage.\n + /// The externalstorage privilege (http://tizen.org/privilege/externalstorage) is needed if the image path is relevant to external storage. /// /// The of the generated image. /// The path to the file to be generated. @@ -44,7 +44,7 @@ namespace Tizen.Multimedia.Vision /// /// BarcodeImageConfiguration imageConfig = new BarcodeImageConfiguration(new Size(500, 400), "/opt/usr/test-barcode-generate-new", BarcodeImageFormat.JPG); /// - /// 3 + /// 3 public BarcodeImageConfiguration(Size size, string path, BarcodeImageFormat imageFormat) { if (size.Width <= 0) @@ -75,8 +75,8 @@ namespace Tizen.Multimedia.Vision /// Initializes a new instance of the class. /// /// - /// The mediastorage privilege(http://tizen.org/privilege/mediastorage) is needed if image path is relevant to media storage.\n - /// The externalstorage privilege(http://tizen.org/privilege/externalstorage) is needed if image path is relevant to external storage. + /// The mediastorage privilege (http://tizen.org/privilege/mediastorage) is needed if the image path is relevant to media storage.\n + /// The externalstorage privilege (http://tizen.org/privilege/externalstorage) is needed if the image path is relevant to external storage. /// /// The width of the image to be generated. /// The height of the image to be generated. @@ -92,7 +92,7 @@ namespace Tizen.Multimedia.Vision /// /// BarcodeImageConfiguration imageConfig = new BarcodeImageConfiguration(500, 400, "/opt/usr/test-barcode-generate-new", BarcodeImageFormat.JPG); /// - /// 3 + /// 3 public BarcodeImageConfiguration(int width, int height, string path, BarcodeImageFormat imageFormat) : this(new Size(width, height), path, imageFormat) { @@ -101,35 +101,35 @@ namespace Tizen.Multimedia.Vision /// /// Gets the size of the image. /// - /// 3 + /// 3 public Size Size { get; } /// /// Gets the width of the image. /// - /// 3 + /// 3 public int Width => Size.Width; /// /// Gets the height of the image. /// - /// 3 + /// 3 public int Height => Size.Height; /// /// Gets the path to the file that has to be generated. /// /// - /// The mediastorage privilege http://tizen.org/privilege/mediastorage is needed if image path is relevant to media storage.\n - /// The externalstorage privilege http://tizen.org/privilege/externalstorage is needed if image path is relevant to external storage. + /// The mediastorage privilege (http://tizen.org/privilege/mediastorage) is needed if the image path is relevant to media storage.\n + /// The externalstorage privilege (http://tizen.org/privilege/externalstorage) is needed if the image path is relevant to external storage. /// - /// 3 + /// 3 public string Path { get; } /// /// Gets the format of the output image. /// - /// 3 + /// 3 public BarcodeImageFormat Format { get; } } } diff --git a/src/Tizen.Multimedia.Vision/MediaVision/BarcodeImageFormat.cs b/src/Tizen.Multimedia.Vision/MediaVision/BarcodeImageFormat.cs index b075bbaa5..de3ff8b2c 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/BarcodeImageFormat.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/BarcodeImageFormat.cs @@ -17,16 +17,16 @@ namespace Tizen.Multimedia.Vision { /// - /// Specifies supported image formats for + /// Specifies the supported image formats for /// /// - /// 3 + /// 3 public enum BarcodeImageFormat { /// /// BMP image format. /// - /// 3 + /// 3 Bmp, /// /// JPEG image format. @@ -36,7 +36,7 @@ namespace Tizen.Multimedia.Vision /// /// PNG image format. /// - /// 3 + /// 3 Png } } diff --git a/src/Tizen.Multimedia.Vision/MediaVision/BarcodeType.cs b/src/Tizen.Multimedia.Vision/MediaVision/BarcodeType.cs index c107c71a7..bcf39308f 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/BarcodeType.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/BarcodeType.cs @@ -20,32 +20,32 @@ namespace Tizen.Multimedia.Vision /// Specifies the supported barcode types. /// /// - /// QR codes (versions 1 to 40) and set of 1D barcodes are supported + /// QR codes (versions 1 to 40) and set of 1D barcodes are supported. /// /// /// - /// 3 + /// 3 public enum BarcodeType { /// /// 2D barcode - Quick Response code. /// - /// 3 + /// 3 QR, /// /// 1D barcode - Universal Product Code with 12-digit. /// - /// 3 + /// 3 UpcA, /// /// 1D barcode - Universal Product Code with 6-digit. /// - /// 3 + /// 3 UpcE, /// /// 1D barcode - International Article Number with 8-digit. /// - /// 3 + /// 3 Ean8, /// /// 1D barcode - International Article Number with 13-digit. @@ -55,17 +55,17 @@ namespace Tizen.Multimedia.Vision /// /// 1D barcode - Code 128. /// - /// 3 + /// 3 Code128, /// /// 1D barcode - Code 39. /// - /// 3 + /// 3 Code39, /// /// 1D barcode - Interleaved Two of Five. /// - /// 3 + /// 3 I25 } } diff --git a/src/Tizen.Multimedia.Vision/MediaVision/EngineConfiguration.cs b/src/Tizen.Multimedia.Vision/MediaVision/EngineConfiguration.cs index 92c14e795..972c0fafa 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/EngineConfiguration.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/EngineConfiguration.cs @@ -24,7 +24,7 @@ namespace Tizen.Multimedia.Vision /// /// A base class for configuration classes. /// - /// 3 + /// 3 public abstract class EngineConfiguration : IDisposable { private IntPtr _handle = IntPtr.Zero; @@ -159,7 +159,7 @@ namespace Tizen.Multimedia.Vision /// Releases the resources used by the object. /// /// - /// true to release both managed and unmanaged resources; false to release only unmanaged resources. + /// true to release both managed and unmanaged resources, otherwise false to release only unmanaged resources. /// protected virtual void Dispose(bool disposing) { diff --git a/src/Tizen.Multimedia.Vision/MediaVision/ErrorCorrectionLevel.cs b/src/Tizen.Multimedia.Vision/MediaVision/ErrorCorrectionLevel.cs index ce5b750c0..5c285bedd 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/ErrorCorrectionLevel.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/ErrorCorrectionLevel.cs @@ -17,30 +17,30 @@ namespace Tizen.Multimedia.Vision { /// - /// Specifies the supported QR code error correction level. + /// Specifies the supported QR code error correction levels. /// - /// 3 + /// 3 public enum ErrorCorrectionLevel { /// /// Recovery up to 7% losses. /// - /// 3 + /// 3 Low, /// /// Recovery up to 15% losses. /// - /// 3 + /// 3 Medium, /// /// Recovery up to 25% losses. /// - /// 3 + /// 3 Quartile, /// /// Recovery up to 30% losses. /// - /// 3 + /// 3 High } } diff --git a/src/Tizen.Multimedia.Vision/MediaVision/EyeCondition.cs b/src/Tizen.Multimedia.Vision/MediaVision/EyeCondition.cs index 0b48dc994..03b7d3b9c 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/EyeCondition.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/EyeCondition.cs @@ -19,25 +19,25 @@ namespace Tizen.Multimedia.Vision /// /// Specifies the eyes state types. /// - /// 3 + /// 3 public enum EyeCondition { /// /// Eyes are open. /// - /// 3 + /// 3 Open, /// /// Eyes are closed. /// - /// 3 + /// 3 Closed, /// /// The eyes condition wasn't determined. /// - /// 3 + /// 3 NotFound } } diff --git a/src/Tizen.Multimedia.Vision/MediaVision/FaceDetectionConfiguration.cs b/src/Tizen.Multimedia.Vision/MediaVision/FaceDetectionConfiguration.cs index 1cb8aee1c..b53b785b5 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/FaceDetectionConfiguration.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/FaceDetectionConfiguration.cs @@ -21,7 +21,7 @@ namespace Tizen.Multimedia.Vision /// /// Represents a configuration of instances. /// - /// 3 + /// 3 public class FaceDetectionConfiguration : EngineConfiguration { private const string KeyModelFilePath = "MV_FACE_DETECTION_MODEL_FILE_PATH"; @@ -45,7 +45,7 @@ namespace Tizen.Multimedia.Vision /// Gets or sets the face detection haarcascade xml file for face detection. /// /// is null. - /// 3 + /// 3 public string ModelFilePath { get @@ -64,13 +64,13 @@ namespace Tizen.Multimedia.Vision /// - /// Gets or sets minimum height of face which will be detected. + /// Gets or sets the minimum height of a face which will be detected. /// /// - /// Default value is null (all detected faces will be applied), can be changed to specify the minimum face height. + /// Default value is null (all detected faces will be applied), which can be changed to specify the minimum face height. /// /// is less than zero. - /// 3 + /// 3 public int? MinHeight { get @@ -92,13 +92,13 @@ namespace Tizen.Multimedia.Vision } /// - /// Gets or sets minimum width of face which will be detected. + /// Gets or sets the minimum width of a face which will be detected. /// /// - /// Default value is null (all detected faces will be applied), can be changed to specify the minimum face width. + /// Default value is null (all detected faces will be applied), which can be changed to specify the minimum face width. /// /// is less than zero. - /// 3 + /// 3 public int? MinWidth { get @@ -127,7 +127,7 @@ namespace Tizen.Multimedia.Vision /// Gets or sets the roi of the face detection. /// /// - /// Default value is null (the roi will be a full image) can be changed to specify the roi for face detection. + /// Default value is null (the roi will be a full image), which can be changed to specify the roi for face detection. /// /// /// The width of is less than or equal to zero.\n @@ -138,7 +138,7 @@ namespace Tizen.Multimedia.Vision /// -or-\n /// The y position of is less than zero.\n /// - /// 3 + /// 3 public Rectangle? Roi { get diff --git a/src/Tizen.Multimedia.Vision/MediaVision/FaceDetector.cs b/src/Tizen.Multimedia.Vision/MediaVision/FaceDetector.cs index 5b33fa380..592a48cf4 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/FaceDetector.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/FaceDetector.cs @@ -23,7 +23,7 @@ namespace Tizen.Multimedia.Vision /// /// Provides the ability to detect faces on image sources. /// - /// 3 + /// 3 public static class FaceDetector { @@ -39,7 +39,7 @@ namespace Tizen.Multimedia.Vision /// -or-\n /// The format of is not supported. /// - /// 3 + /// 3 public static async Task DetectAsync(MediaVisionSource source) { return await DetectAsync(source, null); @@ -54,7 +54,7 @@ namespace Tizen.Multimedia.Vision /// A task that represents the asynchronous detect operation. /// is null. /// The feature is not supported. - /// 3 + /// 3 public static async Task DetectAsync(MediaVisionSource source, FaceDetectionConfiguration config) { diff --git a/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognitionConfiguration.cs b/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognitionConfiguration.cs index 6e99b1741..632ac6b0a 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognitionConfiguration.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognitionConfiguration.cs @@ -19,7 +19,7 @@ namespace Tizen.Multimedia.Vision /// /// Represents a configuration of instances. /// - /// 3 + /// 3 public class FaceRecognitionConfiguration : EngineConfiguration { private const string KeyModelType = "MV_FACE_RECOGNITION_MODEL_TYPE"; @@ -28,7 +28,7 @@ namespace Tizen.Multimedia.Vision /// Initializes a new instance of the class. /// /// The feature is not supported. - /// 3 + /// 3 public FaceRecognitionConfiguration() : base("face_recognition") { } @@ -38,7 +38,7 @@ namespace Tizen.Multimedia.Vision /// Default value is . /// /// is not valid. - /// 3 + /// 3 public FaceRecognitionModelType ModelType { get diff --git a/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognitionModel.cs b/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognitionModel.cs index d2aab08ed..69b29564a 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognitionModel.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognitionModel.cs @@ -24,7 +24,7 @@ namespace Tizen.Multimedia.Vision /// /// Represents the face recognition model interface. /// - /// 3 + /// 3 public class FaceRecognitionModel : IDisposable { private IntPtr _handle = IntPtr.Zero; @@ -34,7 +34,7 @@ namespace Tizen.Multimedia.Vision /// Initializes a new instance of the class. /// /// The feature is not supported. - /// 3 + /// 3 public FaceRecognitionModel() { InteropModel.Create(out _handle).Validate("Failed to create FaceRecognitionModel"); @@ -44,7 +44,7 @@ namespace Tizen.Multimedia.Vision /// Initializes a new instance of the class with the specified path. /// /// - /// Models have been saved by can be loaded. + /// Models saved by can be loaded. /// /// Path to the model to load. /// is null. @@ -56,7 +56,7 @@ namespace Tizen.Multimedia.Vision /// /// No permission to access the specified file. /// - /// 3 + /// 3 public FaceRecognitionModel(string modelPath) { if (modelPath == null) @@ -112,7 +112,7 @@ namespace Tizen.Multimedia.Vision /// No permission to write to the specified path. /// The has already been disposed of. /// The directory for does not exist. - /// 3 + /// 3 public void Save(string path) { if (path == null) @@ -142,7 +142,7 @@ namespace Tizen.Multimedia.Vision } /// - /// Adds face image example to be used for face recognition model learning. + /// Adds the face image example to be used for face recognition model learning. /// /// The that contains face image. /// The label that identifies face for which example is adding. @@ -155,7 +155,7 @@ namespace Tizen.Multimedia.Vision /// has already been dispose of. /// /// - /// 3 + /// 3 public void Add(MediaVisionSource source, int label) { if (source == null) @@ -167,7 +167,7 @@ namespace Tizen.Multimedia.Vision } /// - /// Adds face image example to be used for face recognition model learning. + /// Adds the face image example to be used for face recognition model learning. /// /// The that contains face image. /// The label that identifies face for which example is adding. @@ -181,7 +181,7 @@ namespace Tizen.Multimedia.Vision /// has already been dispose of. /// /// - /// 3 + /// 3 public void Add(MediaVisionSource source, int label, Rectangle area) { if (source == null) @@ -200,7 +200,7 @@ namespace Tizen.Multimedia.Vision /// true if the examples are successfully removed; otherwise, false if there is no example labeled with the specified label. /// /// - /// 3 + /// 3 public bool Remove(int label) { var ret = InteropModel.Remove(Handle, ref label); @@ -218,7 +218,7 @@ namespace Tizen.Multimedia.Vision /// Removes all face examples. /// /// The has already been disposed of. - /// 3 + /// 3 public void Reset() { InteropModel.Reset(Handle).Validate("Failed to reset image example"); @@ -226,31 +226,31 @@ namespace Tizen.Multimedia.Vision /// - /// Learns face recognition model. + /// Learns the face recognition model. /// /// - /// Before you start learning process, face recognition models has to be filled with training data - face image examples. - /// These examples has to be provided by or . - /// Recognition accuracy is usually increased when the different examples of the identical face are added more and more. + /// Before you start the learning process, face recognition models have to be filled with the training data - face image examples. + /// These examples have to be provided by or . + /// Recognition accuracy is usually increased when the different examples of the identical faces are added more and more. /// But it depends on the used learning algorithm. /// /// The has already been disposed of. /// No examples added. /// /// - /// 3 + /// 3 public void Learn() { Learn(null); } /// - /// Learns face recognition model with . + /// Learns the face recognition model with . /// /// - /// Before you start learning process, face recognition models has to be filled with training data - face image examples. - /// These examples has to be provided by or . - /// Recognition accuracy is usually increased when the different examples of the identical face are added more and more. + /// Before you start the learning process, face recognition models have to be filled with the training data - face image examples. + /// These examples have to be provided by or . + /// Recognition accuracy is usually increased when the different examples of the identical faces are added more and more. /// But it depends on the used learning algorithm. /// /// The configuration used for learning of the recognition models. This value can be null. @@ -262,7 +262,7 @@ namespace Tizen.Multimedia.Vision /// No examples added. /// /// - /// 3 + /// 3 public void Learn(FaceRecognitionConfiguration config) { InteropModel.Learn(EngineConfiguration.GetHandle(config), Handle). @@ -270,7 +270,7 @@ namespace Tizen.Multimedia.Vision } /// - /// Releases all resources used by the object. + /// Releases all the resources used by the object. /// public void Dispose() { @@ -282,7 +282,7 @@ namespace Tizen.Multimedia.Vision /// Releases the resources used by the object. /// /// - /// true to release both managed and unmanaged resources; false to release only unmanaged resources. + /// true to release both managed and unmanaged resources; otherwise false to release only unmanaged resources. /// protected virtual void Dispose(bool disposing) { diff --git a/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognitionModelType.cs b/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognitionModelType.cs index f9c967139..2416b5d01 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognitionModelType.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognitionModelType.cs @@ -19,25 +19,25 @@ namespace Tizen.Multimedia.Vision /// /// Specifies the face recognition model learning algorithms. /// - /// 3 + /// 3 public enum FaceRecognitionModelType { /// /// Eigenfaces. /// - /// 3 + /// 3 EigenFaces = 1, /// /// Fisherfaces. /// - /// 3 + /// 3 FisherFaces, /// /// Local Binary Patterns Histograms (LBPH); The default type. /// - /// 3 + /// 3 Lbph } } diff --git a/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognitionResult.cs b/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognitionResult.cs index faa25bee4..ef960c1f5 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognitionResult.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognitionResult.cs @@ -17,9 +17,9 @@ namespace Tizen.Multimedia.Vision { /// - /// Represents result of operations. + /// Represents the result of operations. /// - /// 3 + /// 3 public class FaceRecognitionResult { internal FaceRecognitionResult(bool recognized, double confidence, int label, Rectangle? area) @@ -33,19 +33,19 @@ namespace Tizen.Multimedia.Vision /// /// Gets the value indicating the recognition is successful. /// - /// 3 + /// 3 public bool Success { get; } /// /// Gets the label of the recognized face. /// - /// 3 + /// 3 public int Label { get; } /// /// Gets the location of the recognized face. /// - /// 3 + /// 3 public Rectangle? Area { get; } /// @@ -54,7 +54,7 @@ namespace Tizen.Multimedia.Vision /// threshold for this value can be high (0.85-0.95). If model was learned for small amount of examples, /// then threshold can be reduced (0.5-0.85). /// - /// 3 + /// 3 public double Confidence { get; } } } diff --git a/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognizer.cs b/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognizer.cs index 01d4a9287..034a846de 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognizer.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognizer.cs @@ -22,9 +22,9 @@ using InteropFace = Interop.MediaVision.Face; namespace Tizen.Multimedia.Vision { /// - /// Provides the ability to recognize faces, face expressions and eye condition on image sources. + /// Provides the ability to recognize faces, face expressions, and eye condition on image sources. /// - /// 3 + /// 3 public static class FaceRecognizer { @@ -42,7 +42,7 @@ namespace Tizen.Multimedia.Vision /// The feature is not supported. /// has already been disposed of. /// is untrained model. - /// 3 + /// 3 public static async Task RecognizeAsync(MediaVisionSource source, FaceRecognitionModel recognitionModel) { @@ -64,7 +64,7 @@ namespace Tizen.Multimedia.Vision /// The feature is not supported. /// has already been disposed of. /// is untrained model. - /// 3 + /// 3 public static async Task RecognizeAsync(MediaVisionSource source, FaceRecognitionModel recognitionModel, Rectangle bound) { @@ -90,7 +90,7 @@ namespace Tizen.Multimedia.Vision /// has already been disposed of. /// /// is untrained model. - /// 3 + /// 3 public static async Task RecognizeAsync(MediaVisionSource source, FaceRecognitionModel recognitionModel, FaceRecognitionConfiguration config) { @@ -99,7 +99,7 @@ namespace Tizen.Multimedia.Vision /// - /// Performs face recognition on the source with , + /// Performs face recognition on the source with , /// and a bounding box. /// /// The of the media to recognize faces for. @@ -119,7 +119,7 @@ namespace Tizen.Multimedia.Vision /// has already been disposed of. /// /// is untrained model. - /// 3 + /// 3 public static async Task RecognizeAsync(MediaVisionSource source, FaceRecognitionModel recognitionModel, Rectangle bound, FaceRecognitionConfiguration config) { @@ -211,7 +211,7 @@ namespace Tizen.Multimedia.Vision /// is null. /// has already been disposed of. /// The feature is not supported. - /// 3 + /// 3 public static async Task RecognizeEyeConditionAsync(MediaVisionSource source, Rectangle bound) { @@ -219,7 +219,7 @@ namespace Tizen.Multimedia.Vision } /// - /// Determines eye-blink condition on media source. + /// Determines eye-blink condition on the media source. /// /// The source of the media to recognize eye-blink condition for. /// The bounding the face at the source. @@ -232,7 +232,7 @@ namespace Tizen.Multimedia.Vision /// has already been disposed of. /// /// The feature is not supported. - /// 3 + /// 3 public static async Task RecognizeEyeConditionAsync(MediaVisionSource source, Rectangle bound, FaceRecognitionConfiguration config) { @@ -271,7 +271,7 @@ namespace Tizen.Multimedia.Vision /// is null. /// has already been disposed of. /// The feature is not supported. - /// 3 + /// 3 public static async Task RecognizeFacialExpressionAsync(MediaVisionSource source, Rectangle bound) { @@ -292,7 +292,7 @@ namespace Tizen.Multimedia.Vision /// has already been disposed of. /// /// The feature is not supported. - /// 3 + /// 3 public static async Task RecognizeFacialExpressionAsync(MediaVisionSource source, Rectangle bound, FaceRecognitionConfiguration config) { diff --git a/src/Tizen.Multimedia.Vision/MediaVision/FaceTracker.cs b/src/Tizen.Multimedia.Vision/MediaVision/FaceTracker.cs index 8771dd241..33c7cfc54 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/FaceTracker.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/FaceTracker.cs @@ -24,7 +24,7 @@ namespace Tizen.Multimedia.Vision /// /// Provides the ability to track faces on image sources. /// - /// 3 + /// 3 public static class FaceTracker { @@ -33,8 +33,8 @@ namespace Tizen.Multimedia.Vision /// /// The source of the media to recognize face for. /// The model will be used for tracking. - /// The value indicating whether model learning while tracking. If it is true then model will try to learn - /// (if it supports learning feature), otherwise model will be not learned during the invoking tracking iteration. + /// The value indicating whether model learning while tracking. If it is true, then the model will try to learn + /// (if it supports learning feature), otherwise the model will be not learned during the invoking tracking iteration. /// Learning process improves tracking correctness, but can decrease tracking performance. /// A task that represents the asynchronous tracking operation. /// @@ -49,7 +49,7 @@ namespace Tizen.Multimedia.Vision /// /// The feature is not supported. /// is not prepared. - /// 3 + /// 3 public static async Task TrackAsync(MediaVisionSource source, FaceTrackingModel trackingModel, bool doLearn) { diff --git a/src/Tizen.Multimedia.Vision/MediaVision/FaceTrackingModel.cs b/src/Tizen.Multimedia.Vision/MediaVision/FaceTrackingModel.cs index 1471ae628..793a5d27b 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/FaceTrackingModel.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/FaceTrackingModel.cs @@ -21,9 +21,9 @@ using InteropModel = Interop.MediaVision.FaceTrackingModel; namespace Tizen.Multimedia.Vision { /// - /// Represents face tracking model. + /// Represents the face tracking model. /// - /// 3 + /// 3 public class FaceTrackingModel : IDisposable { private IntPtr _handle = IntPtr.Zero; @@ -33,7 +33,7 @@ namespace Tizen.Multimedia.Vision /// Initializes a new instance of the class. /// /// The feature is not supported. - /// 3 + /// 3 public FaceTrackingModel() { InteropModel.Create(out _handle).Validate("Failed to create FaceTrackingModel."); @@ -43,7 +43,7 @@ namespace Tizen.Multimedia.Vision /// Initializes a new instance of the class with the specified path. /// /// - /// Models has been saved by can be loaded. + /// Models saved by can be loaded. /// /// Path to the model to load. /// is null. @@ -55,7 +55,7 @@ namespace Tizen.Multimedia.Vision /// /// No permission to access the specified file. /// - /// 3 + /// 3 public FaceTrackingModel(string modelPath) { if (modelPath == null) @@ -82,11 +82,11 @@ namespace Tizen.Multimedia.Vision } /// - /// Initializes tracking model by the location of the face to be tracked. + /// Initializes the tracking model by the location of the face to be tracked. /// - /// It is usually called once after tracking model is created and each time before tracking - /// is started for the new sequence of sources which is not the direct continuation of - /// the sequence for which tracking has been performed before. But it is allowed to call it + /// It is usually called once after the tracking model is created, and each time before tracking + /// is started for the new sequence of sources, which is not the direct continuation of + /// the sequence for which tracking has been performed before. But, it is allowed to call it /// between tracking sessions to allow Media Vision start to track more accurately. /// /// @@ -104,7 +104,7 @@ namespace Tizen.Multimedia.Vision /// -or-\n /// has already bean disposed of. /// - /// 3 + /// 3 public void Prepare(MediaVisionSource source, Quadrangle region) { if (source == null) @@ -123,7 +123,7 @@ namespace Tizen.Multimedia.Vision /// No permission to write to the specified path. /// The has already been disposed of. /// The directory for does not exist. - /// 3 + /// 3 public void Save(string path) { if (path == null) @@ -142,7 +142,7 @@ namespace Tizen.Multimedia.Vision } /// - /// Releases all resources used by the object. + /// Releases all the resources used by the object. /// public void Dispose() { @@ -154,7 +154,7 @@ namespace Tizen.Multimedia.Vision /// Releases the resources used by the object. /// /// - /// true to release both managed and unmanaged resources; false to release only unmanaged resources. + /// true to release both managed and unmanaged resources; otherwise false to release only unmanaged resources. /// protected virtual void Dispose(bool disposing) { diff --git a/src/Tizen.Multimedia.Vision/MediaVision/FaceTrackingResult.cs b/src/Tizen.Multimedia.Vision/MediaVision/FaceTrackingResult.cs index dcdc1c1ad..9c86e947f 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/FaceTrackingResult.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/FaceTrackingResult.cs @@ -17,9 +17,9 @@ namespace Tizen.Multimedia.Vision { /// - /// Represents result of face tracking operation. + /// Represents the result of face tracking operation. /// - /// 3 + /// 3 public class FaceTrackingResult { internal FaceTrackingResult(bool success, double confidence, Quadrangle region) @@ -36,16 +36,16 @@ namespace Tizen.Multimedia.Vision public bool Success { get; } /// - /// Gets the region which determines new position of the tracked face on the source. + /// Gets the region which determines the new position of the tracked face on the source. /// - /// 3 + /// 3 public Quadrangle Region { get; } /// - /// The confidence of the tracking model that new location of the face was determined correctly - /// (value from 0.0 to 1.0). If no location was determined during last track iteration, then value is 0.0. + /// The confidence of the tracking model that a new location of the face was determined correctly + /// (value from 0.0 to 1.0). If no location was determined during the last track iteration, then the value is 0.0. /// - /// 3 + /// 3 public double Confidence { get; } } } diff --git a/src/Tizen.Multimedia.Vision/MediaVision/FacialExpression.cs b/src/Tizen.Multimedia.Vision/MediaVision/FacialExpression.cs index f6ee8f046..81dc2729c 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/FacialExpression.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/FacialExpression.cs @@ -19,55 +19,55 @@ namespace Tizen.Multimedia.Vision /// /// Specifies the expression types for faces. /// - /// 3 + /// 3 public enum FacialExpression { /// /// Unknown face expression. /// - /// 3 + /// 3 Unknown, /// /// Face expression is neutral. /// - /// 3 + /// 3 Neutral, /// /// Face expression is smiling. /// - /// 3 + /// 3 Smile, /// /// Face expression is sadness. /// - /// 3 + /// 3 Sadness, /// /// Face expression is surprise. /// - /// 3 + /// 3 Surprise, /// /// Face expression is anger. /// - /// 3 + /// 3 Anger, /// /// Face expression is fear. /// - /// 3 + /// 3 Fear, /// /// Face expression is disgust. /// - /// 3 + /// 3 Disgust } } diff --git a/src/Tizen.Multimedia.Vision/MediaVision/ImageFillConfiguration.cs b/src/Tizen.Multimedia.Vision/MediaVision/ImageFillConfiguration.cs index db2065a21..ab4a38de2 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/ImageFillConfiguration.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/ImageFillConfiguration.cs @@ -19,7 +19,7 @@ namespace Tizen.Multimedia.Vision /// /// Represents a configuration of fill operations of instances. /// - /// 3 + /// 3 public class ImageFillConfiguration : EngineConfiguration { private const string KeyScaleFactor = "MV_IMAGE_RECOGNITION_OBJECT_SCALE_FACTOR"; @@ -28,7 +28,7 @@ namespace Tizen.Multimedia.Vision /// /// A read-only field that represents the default value of . /// - /// 3 + /// 3 public static readonly double DefaultScaleFactor = 1.2; /// @@ -41,7 +41,7 @@ namespace Tizen.Multimedia.Vision /// Initializes a new instance of the class. /// /// The feature is not supported. - /// 3 + /// 3 public ImageFillConfiguration() : base("image_recognition") { } @@ -52,7 +52,7 @@ namespace Tizen.Multimedia.Vision /// The default value is 1.2. /// /// The already has been disposed of. - /// 3 + /// 3 public double ObjectScaleFactor { get @@ -72,7 +72,7 @@ namespace Tizen.Multimedia.Vision /// The default value is 1000. /// /// The already has been disposed of. - /// 3 + /// 3 public int ObjectMaxKeyPoints { get diff --git a/src/Tizen.Multimedia.Vision/MediaVision/ImageObject.cs b/src/Tizen.Multimedia.Vision/MediaVision/ImageObject.cs index 74daec113..c8d2c700c 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/ImageObject.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/ImageObject.cs @@ -23,7 +23,7 @@ namespace Tizen.Multimedia.Vision /// /// Represents an image object. /// - /// 3 + /// 3 public class ImageObject : IDisposable { private IntPtr _handle = IntPtr.Zero; @@ -33,7 +33,7 @@ namespace Tizen.Multimedia.Vision /// Initializes a new instance of the class. /// /// The feature is not supported. - /// 3 + /// 3 public ImageObject() { InteropImage.Create(out _handle).Validate("Failed to create image object"); @@ -43,7 +43,7 @@ namespace Tizen.Multimedia.Vision /// Initializes a new instance of the class from the specified file. /// /// - /// ImageObject has been saved by can be loaded. + /// ImageObject has been saved by can be loaded. /// /// Path to the image object to load. /// is null. @@ -55,7 +55,7 @@ namespace Tizen.Multimedia.Vision /// /// No permission to access the specified file. /// - /// 3 + /// 3 public ImageObject(string path) { if (path == null) @@ -87,7 +87,7 @@ namespace Tizen.Multimedia.Vision /// /// /// - /// 3 + /// 3 public double RecognitionRate { get @@ -106,7 +106,7 @@ namespace Tizen.Multimedia.Vision /// /// The has already been disposed of. /// - /// 3 + /// 3 public int? GetLabel() { var ret = InteropImage.GetLabel(Handle, out var label); @@ -124,7 +124,7 @@ namespace Tizen.Multimedia.Vision /// Sets the label for the . /// /// - /// 3 + /// 3 public void SetLabel(int label) { InteropImage.SetLabel(Handle, label).Validate("Failed to set label"); @@ -141,7 +141,7 @@ namespace Tizen.Multimedia.Vision /// -or-\n /// has already been disposed of. /// - /// 3 + /// 3 public void Fill(MediaVisionSource source) { InvokeFill(source, null, null); @@ -161,7 +161,7 @@ namespace Tizen.Multimedia.Vision /// -or-\n /// has already been disposed of. /// - /// 3 + /// 3 public void Fill(MediaVisionSource source, ImageFillConfiguration config) { InvokeFill(source, config, null); @@ -179,7 +179,7 @@ namespace Tizen.Multimedia.Vision /// -or-\n /// has already been disposed of.\n /// - /// 3 + /// 3 public void Fill(MediaVisionSource source, Rectangle rect) { InvokeFill(source, null, rect); @@ -200,7 +200,7 @@ namespace Tizen.Multimedia.Vision /// -or-\n /// has already been disposed of. /// - /// 3 + /// 3 public void Fill(MediaVisionSource source, ImageFillConfiguration config, Rectangle rect) { InvokeFill(source, config, rect); @@ -237,7 +237,7 @@ namespace Tizen.Multimedia.Vision /// No permission to write to the specified path. /// The has already been disposed of. /// The directory for does not exist. - /// 3 + /// 3 public void Save(string path) { if (path == null) @@ -259,7 +259,7 @@ namespace Tizen.Multimedia.Vision #region IDisposable-support /// - /// Releases all resources used by the object. + /// Releases all the resources used by the object. /// public void Dispose() { @@ -271,7 +271,7 @@ namespace Tizen.Multimedia.Vision /// Releases the resources used by the object. /// /// - /// true to release both managed and unmanaged resources; false to release only unmanaged resources. + /// true to release both managed and unmanaged resources; otherwise false to release only unmanaged resources. /// protected virtual void Dispose(bool disposing) { diff --git a/src/Tizen.Multimedia.Vision/MediaVision/ImageRecognitionConfiguration.cs b/src/Tizen.Multimedia.Vision/MediaVision/ImageRecognitionConfiguration.cs index 785600300..f8647e5df 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/ImageRecognitionConfiguration.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/ImageRecognitionConfiguration.cs @@ -21,7 +21,7 @@ namespace Tizen.Multimedia.Vision /// /// Represents a configuration of . /// - /// 3 + /// 3 public class ImageRecognitionConfiguration : EngineConfiguration { private const string KeySceneScaleFactor = "MV_IMAGE_RECOGNITION_SCENE_SCALE_FACTOR"; @@ -34,38 +34,38 @@ namespace Tizen.Multimedia.Vision /// /// A read-only field that represents the default value of . /// - /// 3 + /// 3 public static readonly double DefaultSceneScaleFactor = 1.2; /// /// A read-only field that represents the default value of . /// - /// 3 + /// 3 public static readonly int DefaultSceneMaxKeypoints = 5000; /// /// A read-only field that represents the default value of . /// - /// 3 + /// 3 public static readonly int DefaultMinKeyPointMatches = 30; /// /// A read-only field that represents the default value of . /// - /// 3 + /// 3 public static readonly double DefaultRequiredMatchPart = 0.05; /// /// A read-only field that represents the default value of . /// - /// 3 + /// 3 public static readonly double DefaultTolerantPartMatchError = 0.1; /// /// Initializes a new instance of the class. /// /// The feature is not supported. - /// 3 + /// 3 public ImageRecognitionConfiguration() : base("image_recognition") { } @@ -78,7 +78,7 @@ namespace Tizen.Multimedia.Vision /// The default is 1.2. /// /// The already has been disposed of. - /// 3 + /// 3 public double SceneScaleFactor { get @@ -101,7 +101,7 @@ namespace Tizen.Multimedia.Vision /// /// The already has been disposed of. /// is less than zero. - /// 3 + /// 3 public int SceneMaxKeyPoints { get @@ -128,7 +128,7 @@ namespace Tizen.Multimedia.Vision /// /// The already has been disposed of. /// is less than zero. - /// 3 + /// 3 public int MinKeyPointMatches { get @@ -150,7 +150,7 @@ namespace Tizen.Multimedia.Vision /// Gets or sets the required matching part for the image recognition. /// To recognize occluded or hidden an image by other images, required relative part of the matches in respect to the total /// amount of matching keypoints required for image recognition. Too low value will result in unsustainable behavior, - /// but effect of object overlapping will be reduced. + /// but the effect of object overlapping will be reduced. /// /// /// The value indicating required relative part of the matches; can be from 0 to 1, inclusive. @@ -162,7 +162,7 @@ namespace Tizen.Multimedia.Vision /// -or-\n /// is greater than one. /// - /// 3 + /// 3 public double RequiredMatchingPart { get diff --git a/src/Tizen.Multimedia.Vision/MediaVision/ImageRecognitionResult.cs b/src/Tizen.Multimedia.Vision/MediaVision/ImageRecognitionResult.cs index 11a1a4c03..5e13c4634 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/ImageRecognitionResult.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/ImageRecognitionResult.cs @@ -19,7 +19,7 @@ namespace Tizen.Multimedia.Vision /// /// Represents a result of RecognizeAsync operations of . /// - /// 3 + /// 3 public class ImageRecognitionResult { @@ -32,7 +32,7 @@ namespace Tizen.Multimedia.Vision /// /// The region of recognized image object on the source image. /// - /// 3 + /// 3 public Quadrangle Region { get; } /// diff --git a/src/Tizen.Multimedia.Vision/MediaVision/ImageRecognizer.cs b/src/Tizen.Multimedia.Vision/MediaVision/ImageRecognizer.cs index 3bf41ddac..b96228572 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/ImageRecognizer.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/ImageRecognizer.cs @@ -24,7 +24,7 @@ namespace Tizen.Multimedia.Vision /// /// Provides the ability to recognize images on image sources. /// - /// 3 + /// 3 public static class ImageRecognizer { /// @@ -43,7 +43,7 @@ namespace Tizen.Multimedia.Vision /// has no elements.(The length is zero.) /// The feature is not supported. /// has already been disposed of. - /// 3 + /// 3 public static async Task> RecognizeAsync( MediaVisionSource source, ImageObject[] imageObjects) { @@ -71,7 +71,7 @@ namespace Tizen.Multimedia.Vision /// -or-\n /// has already been disposed of. /// - /// 3 + /// 3 public static async Task> RecognizeAsync(MediaVisionSource source, ImageObject[] imageObjects, ImageRecognitionConfiguration config) { diff --git a/src/Tizen.Multimedia.Vision/MediaVision/ImageTracker.cs b/src/Tizen.Multimedia.Vision/MediaVision/ImageTracker.cs index 894c3af90..4d95f4da6 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/ImageTracker.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/ImageTracker.cs @@ -24,13 +24,13 @@ namespace Tizen.Multimedia.Vision /// /// Provides the ability to track images on image sources. /// - /// 3 + /// 3 public static class ImageTracker { /// /// Tracks the given image tracking model on the current frame. /// - /// The current image of sequence where image tracking model will be tracked. + /// The current image of sequence where the image tracking model will be tracked. /// The image tracking model which processed as target of tracking. /// A task that represents the asynchronous tracking operation. /// @@ -46,7 +46,7 @@ namespace Tizen.Multimedia.Vision /// /// has no target. /// - /// 3 + /// 3 public static async Task TrackAsync(MediaVisionSource source, ImageTrackingModel trackingModel) { @@ -56,7 +56,7 @@ namespace Tizen.Multimedia.Vision /// /// Tracks the given image tracking model on the current frame and . /// - /// The current image of sequence where image tracking model will be tracked. + /// The current image of sequence where the image tracking model will be tracked. /// The image tracking model which processed as target of tracking. /// The configuration used for tracking. This value can be null. /// A task that represents the asynchronous tracking operation. @@ -75,7 +75,7 @@ namespace Tizen.Multimedia.Vision /// /// has no target. /// - /// 3 + /// 3 public static async Task TrackAsync(MediaVisionSource source, ImageTrackingModel trackingModel, ImageTrackingConfiguration config) { diff --git a/src/Tizen.Multimedia.Vision/MediaVision/ImageTrackingConfiguration.cs b/src/Tizen.Multimedia.Vision/MediaVision/ImageTrackingConfiguration.cs index 5aaab8c09..71d3b23bb 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/ImageTrackingConfiguration.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/ImageTrackingConfiguration.cs @@ -21,7 +21,7 @@ namespace Tizen.Multimedia.Vision /// /// Represents a configuration of . /// - /// 3 + /// 3 public class ImageTrackingConfiguration : ImageRecognitionConfiguration { private const string KeyHistoryAmount = "MV_IMAGE_TRACKING_HISTORY_AMOUNT"; @@ -34,44 +34,44 @@ namespace Tizen.Multimedia.Vision /// /// A read-only field that represents the default value of . /// - /// 3 + /// 3 public static readonly int DefaultHistoryAmount = 3; /// /// A read-only field that represents the default value of . /// - /// 3 + /// 3 public static readonly double DefaultExpectedOffset = 0; /// /// A read-only field that represents the default value of . /// - /// 3 + /// 3 public static readonly bool DefaultStabilizationEnabled = true; /// /// A read-only field that represents the default value of . /// - /// 3 + /// 3 public static readonly double DefaultStabilizationTolerantShift = 0.00006; /// /// A read-only field that represents the default value of . /// - /// 3 + /// 3 public static readonly double DefaultStabilizationSpeed = 0.3; /// /// A read-only field that represents the default value of . /// - /// 3 + /// 3 public static readonly double DefaultStabilizationAcceleration = 0.1; /// /// Initializes a new instance of the class. /// /// The feature is not supported. - /// 3 + /// 3 public ImageTrackingConfiguration() { } @@ -85,7 +85,7 @@ namespace Tizen.Multimedia.Vision /// /// The already has been disposed of. /// is less than zero. - /// 3 + /// 3 public int HistoryAmount { get @@ -107,11 +107,11 @@ namespace Tizen.Multimedia.Vision /// Gets or sets the expected tracking offset. /// /// - /// Relative offset value, for which the object offset is expected (relative to the object size in the current frame).\n + /// Relative offset value for which the object offset is expected (relative to the object size in the current frame).\n /// The default is 0. /// /// The already has been disposed of. - /// 3 + /// 3 public double ExpectedOffset { get @@ -138,7 +138,7 @@ namespace Tizen.Multimedia.Vision /// -or-\n /// is greater than one. /// - /// 3 + /// 3 public double StabilizationAcceleration { get @@ -164,7 +164,7 @@ namespace Tizen.Multimedia.Vision /// The default is 0.3. /// /// The already has been disposed of. - /// 3 + /// 3 public double StabilizationSpeed { get @@ -189,7 +189,7 @@ namespace Tizen.Multimedia.Vision /// The default is 0.00006. /// /// The already has been disposed of. - /// 3 + /// 3 public double StabilizationTolerantShift { get @@ -206,11 +206,11 @@ namespace Tizen.Multimedia.Vision /// Gets or sets the state of the contour stabilization during tracking process. /// /// - /// true if the contour stabilization is enabled; otherwise, false.\n + /// true if the contour stabilization is enabled; otherwise false.\n /// The default is true. /// /// The already has been disposed of. - /// 3 + /// 3 public bool IsStabilizationEnabled { get diff --git a/src/Tizen.Multimedia.Vision/MediaVision/ImageTrackingModel.cs b/src/Tizen.Multimedia.Vision/MediaVision/ImageTrackingModel.cs index 6d7ea290e..056b3ec3f 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/ImageTrackingModel.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/ImageTrackingModel.cs @@ -23,7 +23,7 @@ namespace Tizen.Multimedia.Vision /// /// Represents the image tracking model interface. /// - /// 3 + /// 3 public class ImageTrackingModel : IDisposable { private IntPtr _handle = IntPtr.Zero; @@ -33,7 +33,7 @@ namespace Tizen.Multimedia.Vision /// Initializes a new instance of the class. /// /// The feature is not supported. - /// 3 + /// 3 public ImageTrackingModel() { InteropModel.Create(out _handle).Validate("Failed to create FaceTrackingModel"); @@ -43,7 +43,7 @@ namespace Tizen.Multimedia.Vision /// Initializes a new instance of the class with the specified path. /// /// - /// Model have been saved by can be loaded. + /// Model saved by can be loaded. /// /// Path to the model to load. /// is null. @@ -55,7 +55,7 @@ namespace Tizen.Multimedia.Vision /// /// No permission to access the specified file. /// - /// 3 + /// 3 public ImageTrackingModel(string modelPath) { if (modelPath == null) @@ -71,8 +71,8 @@ namespace Tizen.Multimedia.Vision } /// - /// Sets target of image tracking model.\n - /// Sets image object which will be tracked by using tracking functionality with this tracking model. + /// Sets the target of the image tracking model.\n + /// Sets the image object which will be tracked by using tracking functionality with this tracking model. /// /// Image object which will be set as the target for tracking. /// is null. @@ -81,7 +81,7 @@ namespace Tizen.Multimedia.Vision /// -or-\n /// has already been disposed of. /// - /// 3 + /// 3 public void SetTarget(ImageObject imageObject) { if (imageObject == null) @@ -95,26 +95,26 @@ namespace Tizen.Multimedia.Vision /// /// Refreshes the state of image tracking model.\n - /// Clears moving history and change state to undetected. It is usually called each time before tracking is started - /// for the new sequence of sources which is not the direct continuation of the sequence for which tracking has been performed before. + /// Clears the moving history and change state to undetected. It is usually called each time before tracking is started + /// for the new sequence of sources, which is not the direct continuation of the sequence for which tracking has been performed before. /// Tracking algorithm will try to find image by itself. /// /// The has already been disposed of. - /// 3 + /// 3 public void Refresh() { InteropModel.Refresh(Handle, IntPtr.Zero).Validate("Failed to refresh state"); } /// - /// Saves tracking model to the file. + /// Saves the tracking model to the file. /// /// Path to the file to save the model. /// is null. /// No permission to write to the specified path. /// The has already been disposed of. /// The directory for does not exist. - /// 3 + /// 3 public void Save(string path) { if (path == null) @@ -145,7 +145,7 @@ namespace Tizen.Multimedia.Vision /// Releases the resources used by the object. /// /// - /// true to release both managed and unmanaged resources; false to release only unmanaged resources. + /// true to release both managed and unmanaged resources; otherwise false to release only unmanaged resources. /// protected virtual void Dispose(bool disposing) { diff --git a/src/Tizen.Multimedia.Vision/MediaVision/MediaVisionError.cs b/src/Tizen.Multimedia.Vision/MediaVision/MediaVisionError.cs index a35ae864b..ef43a2468 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/MediaVisionError.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/MediaVisionError.cs @@ -32,43 +32,43 @@ namespace Tizen.Multimedia.Vision { MediaVisionErrorCode = -0x019D0000, /// - /// Successful + /// Successful. /// None = ErrorCode.None, /// - /// Not supported + /// Not supported. /// NotSupported = ErrorCode.NotSupported, /// - /// Message too long + /// Message too long. /// MsgTooLong = ErrorCode.MsgTooLong, /// - /// No data + /// No data. /// NoData = ErrorCode.NoData, /// - /// Key not available + /// Key not available. /// KeyNotAvailable = ErrorCode.KeyNotAvailable, /// - /// Out of memory + /// Out of memory. /// OutOfMemory = ErrorCode.OutOfMemory, /// - /// Invalid parameter + /// Invalid parameter. /// InvalidParameter = ErrorCode.InvalidParameter, /// - /// Invalid operation + /// Invalid operation. /// InvalidOperation = ErrorCode.InvalidOperation, /// - /// Permission denied + /// Permission denied. /// PermissionDenied = ErrorCode.NotPermitted, /// - /// Not supported format + /// Not supported format. /// NotSupportedFormat = MediaVisionErrorCode | 0x01, /// @@ -76,11 +76,11 @@ namespace Tizen.Multimedia.Vision /// Internal = MediaVisionErrorCode | 0x02, /// - /// Invalid data + /// Invalid data. /// InvalidData = MediaVisionErrorCode | 0x03, /// - /// Invalid path (Since 3.0) + /// Invalid path (Since 3.0). /// InvalidPath = MediaVisionErrorCode | 0x04 } diff --git a/src/Tizen.Multimedia.Vision/MediaVision/MediaVisionSource.cs b/src/Tizen.Multimedia.Vision/MediaVision/MediaVisionSource.cs index 9c53f9c05..25a66d67e 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/MediaVisionSource.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/MediaVisionSource.cs @@ -23,9 +23,9 @@ using InteropSource = Interop.MediaVision.MediaSource; namespace Tizen.Multimedia.Vision { /// - /// Represents the media vision source to keep information on image or video frame data as raw buffer. + /// Represents the media vision source to keep information on the image or video frame data as raw buffer. /// - /// 3 + /// 3 public class MediaVisionSource : IBufferOwner, IDisposable { private IntPtr _handle = IntPtr.Zero; @@ -71,7 +71,7 @@ namespace Tizen.Multimedia.Vision /// The feature is not supported. /// is null. /// has already been disposed of. - /// 3 + /// 3 public MediaVisionSource(MediaPacket mediaPacket) : this(handle => FillMediaPacket(handle, mediaPacket)) { @@ -115,7 +115,7 @@ namespace Tizen.Multimedia.Vision /// -or-\n /// is invalid. /// - /// 3 + /// 3 public MediaVisionSource(byte[] buffer, uint width, uint height, ColorSpace colorSpace) : this(handle => FillBuffer(handle, buffer, width, height, colorSpace)) { @@ -132,7 +132,7 @@ namespace Tizen.Multimedia.Vision /// Gets the buffer of the media source. /// /// The has already been disposed of. - /// 3 + /// 3 public IMediaBuffer Buffer { get @@ -161,10 +161,10 @@ namespace Tizen.Multimedia.Vision } /// - /// Gets height of the media source. + /// Gets the height of the media source. /// /// The has already been disposed of. - /// 3 + /// 3 public uint Height { get @@ -177,10 +177,10 @@ namespace Tizen.Multimedia.Vision } /// - /// Gets width of the media source. + /// Gets the width of the media source. /// /// The has already been disposed of. - /// 3 + /// 3 public uint Width { get @@ -196,7 +196,7 @@ namespace Tizen.Multimedia.Vision /// Gets of the media source. /// /// The has already been disposed of. - /// 3 + /// 3 public ColorSpace Colorspace { get @@ -233,7 +233,7 @@ namespace Tizen.Multimedia.Vision /// Releases the resources used by the object. /// /// - /// true to release both managed and unmanaged resources; false to release only unmanaged resources. + /// true to release both managed and unmanaged resources; otherwise false to release only unmanaged resources. /// protected virtual void Dispose(bool disposing) { diff --git a/src/Tizen.Multimedia.Vision/MediaVision/MovementDetectedEventArgs.cs b/src/Tizen.Multimedia.Vision/MediaVision/MovementDetectedEventArgs.cs index 12c4f3a32..a5dba43be 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/MovementDetectedEventArgs.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/MovementDetectedEventArgs.cs @@ -22,13 +22,13 @@ namespace Tizen.Multimedia.Vision /// /// Provides data for the event. /// - /// 3 + /// 3 public class MovementDetectedEventArgs : EventArgs { /// /// Initializes a new instance of the class. /// - /// 3 + /// 3 public MovementDetectedEventArgs(IEnumerable areas) { Areas = areas; @@ -37,7 +37,7 @@ namespace Tizen.Multimedia.Vision /// /// Gets a set of rectangular regions where movement was detected. /// - /// 3 + /// 3 public IEnumerable Areas { get; } } } diff --git a/src/Tizen.Multimedia.Vision/MediaVision/MovementDetectionConfiguration.cs b/src/Tizen.Multimedia.Vision/MediaVision/MovementDetectionConfiguration.cs index 9a146b537..17e691feb 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/MovementDetectionConfiguration.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/MovementDetectionConfiguration.cs @@ -21,7 +21,7 @@ namespace Tizen.Multimedia.Vision /// /// Represents a configuration of . /// - /// 3 + /// 3 public class MovementDetectionConfiguration : SurveillanceEngineConfiguration { private const string KeyThreshold = "MV_SURVEILLANCE_MOVEMENT_DETECTION_THRESHOLD"; @@ -29,7 +29,7 @@ namespace Tizen.Multimedia.Vision /// /// A read-only field that represents the default value of . /// - /// 3 + /// 3 public static readonly int DefaultThreshold = 10; @@ -37,7 +37,7 @@ namespace Tizen.Multimedia.Vision /// Initializes a new instance of the class. /// /// The feature is not supported. - /// 3 + /// 3 public MovementDetectionConfiguration() { } @@ -48,7 +48,7 @@ namespace Tizen.Multimedia.Vision /// to specify the sensitivity of the movement detector. /// /// - /// The value indicating the sensitivity of the from 0 to 255 inclusive + /// The value indicating the sensitivity of from 0 to 255 inclusive, /// where 255 means that no movements will be detected and 0 means that all frame changes /// will be interpreted as movements.\n /// The default is 10. @@ -59,7 +59,7 @@ namespace Tizen.Multimedia.Vision /// -or-\n /// is greater than 255. /// - /// 3 + /// 3 public int Threshold { get diff --git a/src/Tizen.Multimedia.Vision/MediaVision/MovementDetector.cs b/src/Tizen.Multimedia.Vision/MediaVision/MovementDetector.cs index f34562c10..3d1b6e515 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/MovementDetector.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/MovementDetector.cs @@ -23,7 +23,7 @@ namespace Tizen.Multimedia.Vision /// Provides the ability to detect movement on image sources. /// /// - /// 3 + /// 3 public class MovementDetector : SurveillanceEngine { private const string KeyNumberOfRegions = "NUMBER_OF_MOVEMENT_REGIONS"; @@ -35,7 +35,7 @@ namespace Tizen.Multimedia.Vision /// Initializes a new instance of the class. /// /// The feature is not supported. - /// 3 + /// 3 public MovementDetector() : base(MovementDetectedEventType) { } @@ -44,7 +44,7 @@ namespace Tizen.Multimedia.Vision /// Occurs when the movement detected. /// /// The event handler will be executed on an internal thread. - /// 3 + /// 3 public event EventHandler Detected; internal override void OnEventDetected(IntPtr trigger, IntPtr source, int streamId, @@ -90,7 +90,7 @@ namespace Tizen.Multimedia.Vision /// is null. /// The has already been disposed of. /// - /// 3 + /// 3 public void AddSource(SurveillanceSource source) { AddSource(source, null); @@ -108,7 +108,7 @@ namespace Tizen.Multimedia.Vision /// has already been disposed of. /// /// - /// 3 + /// 3 public void AddSource(SurveillanceSource source, MovementDetectionConfiguration config) { InvokeAddSource(source, config); diff --git a/src/Tizen.Multimedia.Vision/MediaVision/PersonAppearanceDetectedEventArgs.cs b/src/Tizen.Multimedia.Vision/MediaVision/PersonAppearanceDetectedEventArgs.cs index cd5d019fb..3e0f94d23 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/PersonAppearanceDetectedEventArgs.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/PersonAppearanceDetectedEventArgs.cs @@ -22,13 +22,13 @@ namespace Tizen.Multimedia.Vision /// /// Provides data for the event. /// - /// 3 + /// 3 public class PersonAppearanceDetectedEventArgs : EventArgs { /// /// Initializes a new instance of the class. /// - /// 3 + /// 3 public PersonAppearanceDetectedEventArgs(IEnumerable appeared, IEnumerable disappeared, IEnumerable tracked) { @@ -40,19 +40,19 @@ namespace Tizen.Multimedia.Vision /// /// Gets a set of rectangular regions where appearances of the persons were detected. /// - /// 3 + /// 3 public IEnumerable AppearanceAreas { get; } /// /// Gets a set of rectangular regions where disappearances of the persons were detected. /// - /// 3 + /// 3 public IEnumerable DisappearanceAreas { get; } /// /// Gets a set of rectangular regions where persons were tracked. /// - /// 3 + /// 3 public IEnumerable TrackedAreas { get; } } } diff --git a/src/Tizen.Multimedia.Vision/MediaVision/PersonAppearanceDetectionConfiguration.cs b/src/Tizen.Multimedia.Vision/MediaVision/PersonAppearanceDetectionConfiguration.cs index 2033d517c..ae503f1e2 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/PersonAppearanceDetectionConfiguration.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/PersonAppearanceDetectionConfiguration.cs @@ -21,7 +21,7 @@ namespace Tizen.Multimedia.Vision /// /// Represents a configuration of instances. /// - /// 3 + /// 3 public class PersonAppearanceDetectionConfiguration : SurveillanceEngineConfiguration { private const string KeySkipFramesCount = "MV_SURVEILLANCE_SKIP_FRAMES_COUNT"; @@ -29,14 +29,14 @@ namespace Tizen.Multimedia.Vision /// /// A read-only field that represents the default value of . /// - /// 3 + /// 3 public static readonly int DefaultSkipFramesCount = 0; /// /// Initializes a new instance of the class. /// /// The feature is not supported. - /// 3 + /// 3 public PersonAppearanceDetectionConfiguration() { } @@ -54,7 +54,7 @@ namespace Tizen.Multimedia.Vision /// The already has been disposed of. /// is less than zero. /// - /// 3 + /// 3 public int SkipFramesCount { get diff --git a/src/Tizen.Multimedia.Vision/MediaVision/PersonAppearanceDetector.cs b/src/Tizen.Multimedia.Vision/MediaVision/PersonAppearanceDetector.cs index bfde49e63..35af496de 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/PersonAppearanceDetector.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/PersonAppearanceDetector.cs @@ -23,7 +23,7 @@ namespace Tizen.Multimedia.Vision /// Provides the ability to detect person appearance changes on image sources. /// /// - /// 3 + /// 3 public class PersonAppearanceDetector : SurveillanceEngine { private const string KeyAppearedNumber = "NUMBER_OF_APPEARED_PERSONS"; @@ -39,7 +39,7 @@ namespace Tizen.Multimedia.Vision /// Initializes a new instance of the class. /// /// The feature is not supported. - /// 3 + /// 3 public PersonAppearanceDetector() : base(PersonAppearanceEventType) { } @@ -48,7 +48,7 @@ namespace Tizen.Multimedia.Vision /// Occurs when the any appearance changes detected. /// /// The event handler will be executed on an internal thread. - /// 3 + /// 3 public event EventHandler Detected; internal override void OnEventDetected(IntPtr trigger, IntPtr source, int streamId, @@ -95,7 +95,7 @@ namespace Tizen.Multimedia.Vision /// is null. /// The has already been disposed of. /// - /// 3 + /// 3 public void AddSource(SurveillanceSource source) { AddSource(source, null); @@ -113,7 +113,7 @@ namespace Tizen.Multimedia.Vision /// has already been disposed of. /// /// - /// 3 + /// 3 public void AddSource(SurveillanceSource source, PersonAppearanceDetectionConfiguration config) { InvokeAddSource(source, config); diff --git a/src/Tizen.Multimedia.Vision/MediaVision/PersonRecognitionConfiguration.cs b/src/Tizen.Multimedia.Vision/MediaVision/PersonRecognitionConfiguration.cs index 10e6edde4..d8173241a 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/PersonRecognitionConfiguration.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/PersonRecognitionConfiguration.cs @@ -21,7 +21,7 @@ namespace Tizen.Multimedia.Vision /// /// Represents a configuration of instances. /// - /// 3 + /// 3 public class PersonRecognitionConfiguration : SurveillanceEngineConfiguration { private const string KeyFaceRecognitionModelFilePath = "MV_SURVEILLANCE_FACE_RECOGNITION_MODEL_FILE_PATH"; @@ -32,7 +32,7 @@ namespace Tizen.Multimedia.Vision /// Path to the face recognition model. /// is null. /// The feature is not supported. - /// 3 + /// 3 public PersonRecognitionConfiguration(string modelPath) { FaceRecognitionModelPath = modelPath; @@ -43,7 +43,7 @@ namespace Tizen.Multimedia.Vision /// /// is null. /// The already has been disposed of. - /// 3 + /// 3 public string FaceRecognitionModelPath { get diff --git a/src/Tizen.Multimedia.Vision/MediaVision/PersonRecognitionInfo.cs b/src/Tizen.Multimedia.Vision/MediaVision/PersonRecognitionInfo.cs index 3cd326dd0..116253243 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/PersonRecognitionInfo.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/PersonRecognitionInfo.cs @@ -19,13 +19,13 @@ namespace Tizen.Multimedia.Vision /// /// Represents a result of instances. /// - /// 3 + /// 3 public class PersonRecognitionInfo { /// /// Initializes a new instance of the class. /// - /// 3 + /// 3 public PersonRecognitionInfo(Rectangle area, int label, double confidence) { Area = area; @@ -42,13 +42,13 @@ namespace Tizen.Multimedia.Vision /// /// Gets the label that correspond to the recognized person. /// - /// 3 + /// 3 public int Label { get; } /// /// Gets the confidence value that correspond to the recognized person. /// - /// 3 + /// 3 public double Confidence { get; } } } diff --git a/src/Tizen.Multimedia.Vision/MediaVision/PersonRecognizedEventArgs.cs b/src/Tizen.Multimedia.Vision/MediaVision/PersonRecognizedEventArgs.cs index dc48ec392..4b8b7b8b8 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/PersonRecognizedEventArgs.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/PersonRecognizedEventArgs.cs @@ -22,13 +22,13 @@ namespace Tizen.Multimedia.Vision /// /// Provides data for the event. /// - /// 3 + /// 3 public class PersonRecognizedEventArgs : EventArgs { /// /// Initializes a new instance of the class. /// - /// 3 + /// 3 public PersonRecognizedEventArgs(IEnumerable recognitionInfo) { Recognitions = recognitionInfo; @@ -37,7 +37,7 @@ namespace Tizen.Multimedia.Vision /// /// Gets a set of information that correspond to the recognized persons. /// - /// 3 + /// 3 public IEnumerable Recognitions { get; } } } diff --git a/src/Tizen.Multimedia.Vision/MediaVision/PersonRecognizer.cs b/src/Tizen.Multimedia.Vision/MediaVision/PersonRecognizer.cs index 5f191c4be..8bdf8348d 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/PersonRecognizer.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/PersonRecognizer.cs @@ -23,7 +23,7 @@ namespace Tizen.Multimedia.Vision /// Provides the ability to recognize person on image sources. /// /// - /// 3 + /// 3 public class PersonRecognizer : SurveillanceEngine { private const string KeyCount = "NUMBER_OF_PERSONS"; @@ -37,7 +37,7 @@ namespace Tizen.Multimedia.Vision /// Initializes a new instance of the class. /// /// The feature is not supported. - /// 3 + /// 3 public PersonRecognizer() : base(PersonRecognizedEventType) { } @@ -47,7 +47,7 @@ namespace Tizen.Multimedia.Vision /// /// The event handler will be executed on an internal thread. /// - /// 3 + /// 3 public event EventHandler Recognized; internal override void OnEventDetected(IntPtr trigger, IntPtr source, int streamId, @@ -115,7 +115,7 @@ namespace Tizen.Multimedia.Vision /// /// The model file is not supported format or file. /// - /// 3 + /// 3 public void AddSource(SurveillanceSource source, PersonRecognitionConfiguration config) { if (config == null) diff --git a/src/Tizen.Multimedia.Vision/MediaVision/QrConfiguration.cs b/src/Tizen.Multimedia.Vision/MediaVision/QrConfiguration.cs index 5daaac78c..e6d8a97a7 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/QrConfiguration.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/QrConfiguration.cs @@ -21,7 +21,7 @@ namespace Tizen.Multimedia.Vision /// /// Represents a QR configuration of . /// - /// 3 + /// 3 public class QrConfiguration { /// @@ -43,7 +43,7 @@ namespace Tizen.Multimedia.Vision /// -or- /// is invalid. /// - /// 3 + /// 3 public QrConfiguration(QrMode qrMode, ErrorCorrectionLevel ecc, int version) { if (version < 1 || version > 40) @@ -62,19 +62,19 @@ namespace Tizen.Multimedia.Vision /// /// Gets the encoding mode for the message. /// - /// 3 + /// 3 public QrMode Mode { get; } /// /// Gets the error correction level. /// - /// 3 + /// 3 public ErrorCorrectionLevel ErrorCorrectionLevel { get; } /// /// Gets the QR code version. /// - /// 3 + /// 3 public int Version { get; } } } diff --git a/src/Tizen.Multimedia.Vision/MediaVision/QrMode.cs b/src/Tizen.Multimedia.Vision/MediaVision/QrMode.cs index 5721f9d24..14f547774 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/QrMode.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/QrMode.cs @@ -17,7 +17,7 @@ namespace Tizen.Multimedia.Vision { /// - /// Specifies the supported QR code encoding mode. + /// Specifies the supported QR code encoding modes. /// /// 3 public enum QrMode @@ -25,7 +25,7 @@ namespace Tizen.Multimedia.Vision /// /// Numeric digits. /// - /// 3 + /// 3 Numeric, /// /// Alphanumeric characters, '$', '%', '*', '+', '-', '.', '/' and ':'. @@ -35,12 +35,12 @@ namespace Tizen.Multimedia.Vision /// /// Raw 8-bit bytes. /// - /// 3 + /// 3 Byte, /// /// UTF-8 character encoding. /// - /// 3 + /// 3 Utf8 } } diff --git a/src/Tizen.Multimedia.Vision/MediaVision/Quadrangle.cs b/src/Tizen.Multimedia.Vision/MediaVision/Quadrangle.cs index aff9ba3bb..708621cfd 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/Quadrangle.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/Quadrangle.cs @@ -21,17 +21,17 @@ namespace Tizen.Multimedia.Vision /// /// Represents a region with 4 s. /// - /// 3 + /// 3 public class Quadrangle { /// - /// Initialize a new instance of the class with an array of . + /// Initializes a new instance of the class with an array of . /// /// must have 4 elements. - /// four points that define object bounding quadrangle. - /// The Length of is not 4. - /// 3 + /// Four points that define the object bounding quadrangle. + /// The length of is not 4. + /// 3 public Quadrangle(Point[] points) { if (points.Length != 4) @@ -45,7 +45,7 @@ namespace Tizen.Multimedia.Vision /// /// Gets four points that define the object bounding quadrangle. /// - /// 3 + /// 3 public Point[] Points { get; } /// diff --git a/src/Tizen.Multimedia.Vision/MediaVision/SurveillanceConfiguration.cs b/src/Tizen.Multimedia.Vision/MediaVision/SurveillanceConfiguration.cs index a81af9dae..27583146b 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/SurveillanceConfiguration.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/SurveillanceConfiguration.cs @@ -19,7 +19,7 @@ namespace Tizen.Multimedia.Vision /// /// SurveillanceEngineConfiguration is a base class for surveillance configurations. /// - /// 3 + /// 3 public class SurveillanceEngineConfiguration : EngineConfiguration { internal SurveillanceEngineConfiguration() : base("face_recognition", "image_recognition") diff --git a/src/Tizen.Multimedia.Vision/MediaVision/SurveillanceEngine.cs b/src/Tizen.Multimedia.Vision/MediaVision/SurveillanceEngine.cs index 52f715d55..b3921a419 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/SurveillanceEngine.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/SurveillanceEngine.cs @@ -22,12 +22,12 @@ namespace Tizen.Multimedia.Vision { /// /// SurveillanceEngine is a base class for surveillance event triggers. - /// Media Vision Surveillance provides functionality can be utilized for creation of video surveillance systems. + /// Media Vision Surveillance provides the functionality which can be utilized for creation of video surveillance systems. /// /// /// /// - /// 3 + /// 3 public abstract class SurveillanceEngine : IDisposable { private IntPtr _handle = IntPtr.Zero; @@ -36,7 +36,7 @@ namespace Tizen.Multimedia.Vision /// /// Initializes a new instance of the class. /// - /// The type of the event trigger + /// The type of the event trigger. internal SurveillanceEngine(string eventType) { EventTriggerCreate(eventType, out _handle).Validate("Failed to create surveillance event trigger."); @@ -60,10 +60,10 @@ namespace Tizen.Multimedia.Vision } /// - /// Sets and gets ROI (Region Of Interest). + /// Sets and gets the ROI (Region Of Interest). /// /// The has already been disposed of. - /// 3 + /// 3 public Point[] Roi { get @@ -119,7 +119,7 @@ namespace Tizen.Multimedia.Vision /// is null. /// The has already been disposed of. /// has not been added. - /// 3 + /// 3 public void RemoveSource(SurveillanceSource source) { if (source == null) @@ -131,7 +131,7 @@ namespace Tizen.Multimedia.Vision /// - /// Releases all resources used by the object. + /// Releases all the resources used by the object. /// public void Dispose() { @@ -143,7 +143,7 @@ namespace Tizen.Multimedia.Vision /// Releases the resources used by the object. /// /// - /// true to release both managed and unmanaged resources; false to release only unmanaged resources. + /// true to release both managed and unmanaged resources; otherwise false to release only unmanaged resources. /// protected virtual void Dispose(bool disposing) { diff --git a/src/Tizen.Multimedia.Vision/MediaVision/SurveillanceSource.cs b/src/Tizen.Multimedia.Vision/MediaVision/SurveillanceSource.cs index 19c8d479f..6f5d6a1db 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/SurveillanceSource.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/SurveillanceSource.cs @@ -20,12 +20,12 @@ using static Interop.MediaVision.Surveillance; namespace Tizen.Multimedia.Vision { /// - /// Provides the ability to push source to surveillance engines. + /// Provides the ability to push the source to surveillance engines. /// /// /// /// - /// 3 + /// 3 public class SurveillanceSource { private static int _nextStreamId = int.MinValue; @@ -42,14 +42,14 @@ namespace Tizen.Multimedia.Vision /// /// Initializes a new instance of the class. /// - /// 3 + /// 3 public SurveillanceSource() { StreamId = GetNextStreamId(); } /// - /// Pushes source to the surveillance system to detect events. + /// Pushes the source to the surveillance system to detect events. /// /// The media source used for surveillance. /// is null.