From 9bc3ae413c5a5e2c4a57d8375d4f65ed416ce9b7 Mon Sep 17 00:00:00 2001 From: =?utf8?q?=E2=80=9CEditor?= Date: Fri, 15 Dec 2017 11:27:00 +0530 Subject: [PATCH] Review Tizen API cs files PS2: Feedback implementation Change-Id: I3b04998332b48e3e72c5bd98ba0db8e27e5434a2 --- src/Tizen/Tizen.Common/Color.cs | 74 +++++----- src/Tizen/Tizen.Common/DotnetUtil.cs | 2 +- src/Tizen/Tizen.Internals.Errors/ErrorCode.cs | 196 ++++++++++++------------- src/Tizen/Tizen.Internals.Errors/ErrorFacts.cs | 8 +- 4 files changed, 140 insertions(+), 140 deletions(-) diff --git a/src/Tizen/Tizen.Common/Color.cs b/src/Tizen/Tizen.Common/Color.cs index 349d9bd..278651f 100644 --- a/src/Tizen/Tizen.Common/Color.cs +++ b/src/Tizen/Tizen.Common/Color.cs @@ -141,12 +141,12 @@ namespace Tizen.Common private int _value; /// - /// Initiates new Color with r,g,b,a components. + /// Initiates the new color with R,G,B,A components. /// - /// Red (0 ~ 255) - /// Green (0 ~ 255) - /// Blue (0 ~ 255) - /// Alpha (0 ~ 255) + /// Red (0 ~ 255). + /// Green (0 ~ 255). + /// Blue (0 ~ 255). + /// Alpha (0 ~ 255). /// 3 public Color(int r, int g, int b, int a) { @@ -163,11 +163,11 @@ namespace Tizen.Common } /// - /// Initiates new Color with r,g,b components. The alpha value will be 255 as default. + /// Initiates the new color with R,G,B components. The Alpha value will be 255 as default. /// - /// Red (0 ~ 255) - /// Green (0 ~ 255) - /// Blue (0 ~ 255) + /// Red (0 ~ 255). + /// Green (0 ~ 255). + /// Blue (0 ~ 255). /// 3 public Color(int r, int g, int b) : this(r, g, b, 255) { @@ -194,7 +194,7 @@ namespace Tizen.Common } /// - /// Gets the blue component of the color. + /// Gets the Blue component of the color. /// /// 3 public int B @@ -203,7 +203,7 @@ namespace Tizen.Common } /// - /// Gets the alpha component of the color. + /// Gets the Alpha component of the color. /// /// 3 public int A @@ -216,11 +216,11 @@ namespace Tizen.Common #region Static Methods /// - /// Returns a boolean indicating whether the two given Colors are equal. + /// Returns a boolean indicating whether the two given colors are equal. /// - /// The first Color to compare. - /// The second Color to compare. - /// True if the Colors are equal; False otherwise. + /// The first color to compare. + /// The second color to compare. + /// True if the colors are equal; False otherwise. /// 3 public static bool operator ==(Color color1, Color color2) { @@ -228,11 +228,11 @@ namespace Tizen.Common } /// - /// Returns a boolean indicating whether the two given Colors are not equal. + /// Returns a boolean indicating whether the two given colors are not equal. /// - /// The first Color to compare. - /// The second Color to compare. - /// True if the Colors are not equal; False if they are equal. + /// The first color to compare. + /// The second color to compare. + /// True if the colors are not equal; False if they are equal. /// 3 public static bool operator !=(Color color1, Color color2) { @@ -242,9 +242,9 @@ namespace Tizen.Common /// /// Returns a new RGB color instance. /// - /// The red component of the color. - /// The green component of the color. - /// The blue component of the color. + /// The Red component of the color. + /// The Green component of the color. + /// The Blue component of the color. /// /// 3 public static Color FromRgb(int r, int g, int b) @@ -255,11 +255,11 @@ namespace Tizen.Common /// /// Returns a new RGBA color instance. /// - /// The red component of the color. - /// The green component of the color. - /// The blue component of the color. - /// The alpha component of the color. - /// the RGBA color instance. + /// The Red component of the color. + /// The Green component of the color. + /// The Blue component of the color. + /// The Alpha component of the color. + /// The RGBA color instance. /// 3 public static Color FromRgba(int r, int g, int b, int a) { @@ -267,10 +267,10 @@ namespace Tizen.Common } /// - /// Returns a new RGB Color instance with the requested Red, Green, and Blue channels. The Alpha channel is set if hex contains one. + /// Returns a new RGB color instance with the requested Red, Green, and Blue channels. The Alpha channel is set if hex contains one. /// /// A string that contains the hexadecimal RGB(A) color representation. - /// the RGBA color instance. + /// The RGBA color instance. /// 3 public static Color FromHex(string hex) { @@ -327,7 +327,7 @@ namespace Tizen.Common } /// - /// Returns a string representation in Hex. (ex: \#FFFFFFFF in RGBA order) + /// Returns a string representation in Hex (For example: \#FFFFFFFF in RGBA order). /// /// The string representation in Hex. /// 3 @@ -337,10 +337,10 @@ namespace Tizen.Common } /// - /// Returns a boolean indicating whether the given Color is equal to this Color instance. + /// Returns a boolean indicating whether the given color is equal to this Color instance. /// - /// The Color to compare this instance to. - /// True if the other Color is equal to this instance; False otherwise. + /// The color to compare this instance to. + /// True if the other color is equal to this instance; False otherwise. /// 3 public bool Equals(Color other) { @@ -348,10 +348,10 @@ namespace Tizen.Common } /// - /// Returns a boolean indicating whether the given Object is equal to this Color instance. + /// Returns a boolean indicating whether the given object is equal to this Color instance. /// - /// The Object to compare against. - /// True if the Object is equal to this Color; False otherwise. + /// The object to compare against. + /// True if the object is equal to this color; False otherwise. /// 3 public override bool Equals(object obj) { @@ -363,7 +363,7 @@ namespace Tizen.Common } /// - /// Returns a string representation of the Color. + /// Returns a string representation of the color. /// /// The string representation. /// 3 diff --git a/src/Tizen/Tizen.Common/DotnetUtil.cs b/src/Tizen/Tizen.Common/DotnetUtil.cs index 8fde49a..ae51615 100644 --- a/src/Tizen/Tizen.Common/DotnetUtil.cs +++ b/src/Tizen/Tizen.Common/DotnetUtil.cs @@ -27,7 +27,7 @@ namespace Tizen.Common /// /// Gets the version of Tizen .NET API. /// - /// The Tizen .NET API version + /// The Tizen .NET API version. /// 4 public static int TizenAPIVersion { diff --git a/src/Tizen/Tizen.Internals.Errors/ErrorCode.cs b/src/Tizen/Tizen.Internals.Errors/ErrorCode.cs index c237bf3..68d7af9 100644 --- a/src/Tizen/Tizen.Internals.Errors/ErrorCode.cs +++ b/src/Tizen/Tizen.Internals.Errors/ErrorCode.cs @@ -17,494 +17,494 @@ namespace Tizen.Internals.Errors { /// - /// Error codes used inside Tizen .NET API implementation + /// Error codes used inside Tizen .NET API implementation. /// /// 3 public enum ErrorCode : int { /// - /// Successful + /// Successful. /// None = 0, // 0 /// - /// Operation not permitted + /// Operation not permitted. /// NotPermitted = -1, // -EPERM /// - /// No such file or directory + /// No such file or directory. /// NoSuchFile = -2, // -ENOENT /// - /// No such process + /// No such process. /// NoSuchProcess = -3, // -ESRCH /// - /// Interrupted system call + /// Interrupted system call. /// InterruptedSysCall = -4, // -EINTR /// - /// I/O error + /// I/O error. /// IoError = -5, // -EIO /// - /// No such device or address + /// No such device or address. /// NoSuchDevice = -6, // -ENXIO /// - /// Argument list too long + /// Argument list too long. /// ArgumentListTooLong = -7, // -E2BIG /// - /// Exec format error + /// Executable format error. /// ExecFormatError = -8, // -ENOEXEC /// - /// Bad file number + /// Bad file number. /// BadFileNumber = -9, // -EBADF /// - /// Try again + /// Try again. /// TryAgain = -11, // -EAGAIN /// - /// Out of memory + /// Out of memory. /// OutOfMemory = -12, // -ENOMEM /// - /// Permission denied + /// Permission denied. /// PermissionDenied = -13, // -EACCES /// - /// Bad address + /// Bad address. /// BadAddress = -14, // -EFAULT /// - /// Block device required + /// Block device required. /// BlockDeviceRequired = -15, // -ENOTBLK /// - /// Device or resource busy + /// Device or resource busy. /// ResourceBusy = -16, // -EBUSY /// - /// File exists + /// File exists. /// FileExists = -17, // -EEXIST /// - /// Cross-device link + /// Cross-device link. /// CrossDeviceLink = -18, // -EXDEV /// - /// Not a directory + /// Not a directory. /// NotaDirectory = -20, // -ENOTDIR /// - /// Is a directory + /// Is a directory. /// IsADirectory = -21, // -EISDIR /// - /// Invalid function parameter + /// Invalid function parameter. /// InvalidParameter = -22, // -EINVAL /// - /// File table overflow + /// File table overflow. /// FileTableOverflow = -23, // -ENFILE /// - /// Too many open files + /// Too many open files. /// TooManyOpenFiles = -24, // -EMFILE /// - /// Not a terminal + /// Not a terminal. /// TooNotaTerminal = -25, // -ENOTTY /// - /// Too text file busy + /// Too text file busy. /// TooTextFileBusy = -26, // -ETXTBSY /// - /// File too large + /// File too large. /// FileTooLarge = -27, // -EFBIG /// - /// No space left on device + /// No space left on device. /// FileNoSpaceOnDevice = -28, // -ENOSPC /// - /// Illegal seek + /// Illegal seek. /// IllegalSeek = -29, // -ESPIPE /// - /// Read-only file system + /// Read-only file system. /// ReadOnlyFilesystem = -30, // -EROFS /// - /// No data available + /// No data available. /// NoData = -61, // -ENODATA /// - /// Too many links + /// Too many links. /// TooManyLinks = -31, // -EMLINK /// - /// Broken pipe + /// Broken pipe. /// BrokenPipe = -32, // -EPIPE /// - /// Math argument out of domain of func + /// Math argument out of domain of the function. /// ArgumentOutOfDomain = -33, // -EDOM /// - /// Math result not representable + /// Math result not representable. /// ResultOutOfRange = -34, // -ERANGE /// - /// Resource deadlock would occur + /// Resource deadlock would occur. /// WouldCauseDeadlock = -35, // -EDEADLK /// - /// File name too long + /// File name too long. /// FileNameTooLong = -36, // -ENAMETOOLONG /// - /// No record locks available + /// No record locks available. /// FileNoLocksAvailable = -37, // -ENOLCK /// - /// Function not implemented + /// Function not implemented. /// InvalidOperation = -38, // -ENOSYS /// - /// Directory not empty + /// Directory not empty. /// DirNotEmpty = -39, // -ENOTEMPTY /// - /// Too many symbolic links encountered + /// Too many symbolic links encountered. /// TooManySymbolicLinks = -40, // -ELOOP /// - /// Operation would block + /// Operation would block. /// WouldBlock = -11, // TryAgain (-EAGAIN) /// - /// Accessing a corrupted shared library + /// Accessing a corrupted shared library. /// CorruptedSharedLib = -80, // -ELIBBAD /// - /// .lib section in a.out corrupted + /// .lib section in a.out corrupted. /// LibSectionCorrupted = -81, // -ELIBSCN /// - /// Attempting to link in too many shared libraries + /// Attempting to link in too many shared libraries. /// LinkTooManySharedLib = -82, // -ELIBMAX /// - /// Cannot exec a shared library directly + /// Cannot execute a shared library directly. /// SharedLibExec = -83, // -ELIBEXEC /// - /// Illegal byte sequence + /// Illegal byte sequence. /// IllegalByteSeq = -84, // -EILSEQ /// - /// Interrupted system call should be restarted + /// Interrupted system call should be restarted. /// SystemCallRestart = -85, // -ERESTART /// - /// Streams pipe error + /// Streams pipe error. /// StreamsPipe = -86, // -ESTRPIPE /// - /// Too many users + /// Too many users. /// TooManyUsers = -87, // -EUSERS /// - /// Socket operation on non-socket + /// Socket operation on non-socket. /// NonSocket = -88, // -ENOTSOCK /// - /// Destination address required + /// Destination address required. /// NoDestAddress = -89, // -EDESTADDRREQ /// - /// Message too long + /// Message too long. /// MsgTooLong = -90, // -EMSGSIZE /// - /// Protocol wrong type for socket + /// Protocol wrong type for socket. /// ProtocolWrongType = -91, // -EPROTOTYPE /// - /// Protocol not available + /// Protocol not available. /// ProtocolNotAvaliable = -92, // -ENOPROTOOPT /// - /// Protocol not supported + /// Protocol not supported. /// ProtocolNotSupported = -93, // -EPROTONOSUPPORT /// - /// Socket type not supported + /// Socket type not supported. /// SocketTypeNotSupported = -94, // -ESOCKTNOSUPPORT /// - /// Operation not supported on transport endpoint + /// Operation not supported on the transport endpoint. /// EndpointOperatinNotSupported = -95, // -EOPNOTSUPP /// - /// Protocol family not supported + /// Protocol family not supported. /// ProtocolFamilyNotSupported = -96, // -EPFNOSUPPORT /// - /// Address family not supported by protocol + /// Address family not supported by protocol. /// AddressFamilyNotSupported = -97, // -EAFNOSUPPORT /// - /// Address already in use + /// Address already in use. /// AddresInUse = -98, // -EADDRINUSE /// - /// Cannot assign requested address + /// Cannot assign requested address. /// CannotAssignAddress = -99, // -EADDRNOTAVAIL /// - /// Network is down + /// Network down. /// Networkdown = -100, // -ENETDOWN /// - /// Network is unreachable + /// Network unreachable. /// NetworkUnreachable = -101, // -ENETUNREACH /// - /// Network dropped connection because of reset + /// Network dropped the connection because of the reset. /// NetworkReset = -102, // -ENETRESET /// - /// Software caused connection abort + /// Software caused the connection to abort. /// ConnectionAborted = -103, // -ECONNABORTED /// - /// Connection reset by peer + /// Connection reset by the peer. /// ConnectionResetByPeer = -104, // -ECONNRESET /// - /// No buffer space available + /// No buffer space available. /// BufferSpace = -105, // -ENOBUFS /// - /// Transport endpoint is already connected + /// Transport endpoint already connected. /// EndpointConnected = -106, // -EISCONN /// - /// Transport endpoint is not connected + /// Transport endpoint not connected. /// EndpointNotConnected = -107, // -ENOTCONN /// - /// Cannot send after transport endpoint shutdown + /// Cannot send after the transport endpoint shutdown. /// EndpointShutdown = -108, // -ESHUTDOWN /// - /// Too many references: cannot splice + /// Too many references: cannot splice. /// TooManyReferences = -109, // -ETOOMANYREFS /// - /// Connection timed out + /// Connection timed out. /// ConnectionTimeout = -110, // -ETIMEDOUT /// - /// Connection refused + /// Connection refused. /// ConnectionRefused = -111, // -ECONNREFUSED /// - /// Host is down + /// Host down. /// Hostdown = -112, // -EHOSTDOWN /// - /// No route to host + /// No route to host. /// NoRouteToHost = -113, // -EHOSTUNREACH /// - /// Operation already in progress + /// Operation already in progress. /// AlreadyInProgress = -114, // -EALREADY /// - /// Operation now in progress + /// Operation now in progress. /// NowInProgress = -115, // -EINPROGRESS /// - /// Stale NFS file handle + /// Stale NFS file handle. /// StaleNfsFileHandle = -116, // -ESTALE /// - /// Structure needs cleaning + /// Structure needs cleaning. /// StructureUnclean = -117, // -EUCLEAN /// - /// Not a XENIX named type file + /// Not a XENIX named type file. /// NotXenixNamedTypeFile = -118, // -ENOTNAM /// - /// No XENIX semaphores available + /// No XENIX semaphores available. /// NoXenixSemaphoresAvailable = -119, // -ENAVAIL /// - /// Is a named type file + /// Is a named type file. /// IsNamedTypeFile = -120, // -EISNAM /// - /// Remote I/O error + /// Remote I/O error. /// RemoteIo = -121, // -EREMOTEIO /// - /// Quota exceeded + /// Quota exceeded. /// QuotaExceeded = -122, // -EDQUOT /// - /// No medium found + /// No medium found. /// NoMedium = -123, // -ENOMEDIUM /// - /// Wrong medium type + /// Wrong medium type. /// WrongMediumType = -124, // -EMEDIUMTYPE /// - /// Operation Canceled + /// Operation Canceled. /// Canceled = -125, // -ECANCELED /// - /// Required key not available + /// Required key not available. /// KeyNotAvailable = -126, // -ENOKEY /// - /// Key has expired + /// Key has expired. /// KeyExpired = -127, // -EKEYEXPIRED /// - /// Key has been revoked + /// Key has been revoked. /// KeyRevoked = -128, // -EKEYREVOKED /// - /// Key was rejected by service + /// Key was rejected by the service. /// KeyRejected = -129, // -EKEYREJECTED /// - /// Owner died (for robust mutexes) + /// Owner died (for robust mutexes). /// OwnerDead = -130, // -EOWNERDEAD /// - /// Unknown error + /// Unknown error. /// Unknown = -1073741824, // TIZEN_ERROR_MIN_PLATFORM_ERROR /// - /// Time out + /// Timed out. /// TimedOut, /// - /// Not Supported + /// Not supported. /// NotSupported, /// - /// Not Consented + /// Not consented. /// UserNotConsented, /// - /// The end of collection + /// The end of collection. /// EndofCollection } diff --git a/src/Tizen/Tizen.Internals.Errors/ErrorFacts.cs b/src/Tizen/Tizen.Internals.Errors/ErrorFacts.cs index e4d5e60..bee6269 100644 --- a/src/Tizen/Tizen.Internals.Errors/ErrorFacts.cs +++ b/src/Tizen/Tizen.Internals.Errors/ErrorFacts.cs @@ -20,7 +20,7 @@ using System.Runtime.InteropServices; namespace Tizen.Internals.Errors { /// - /// Provides functions that return additional information about the + /// Provides functions that return the additional information about . /// /// 3 public static class ErrorFacts @@ -28,7 +28,7 @@ namespace Tizen.Internals.Errors /// /// Gets the last error code in the thread. /// - /// One of + /// One of . /// 3 public static int GetLastResult() { @@ -36,9 +36,9 @@ namespace Tizen.Internals.Errors } /// - /// Gets the message for given the error code. + /// Gets the message for the given error code. /// - /// One of + /// One of . /// /// 3 public static string GetErrorMessage(int errorCode) -- 2.7.4