From 535447b16ede4bb2380a21a1a6b0028f99e6ab43 Mon Sep 17 00:00:00 2001 From: Editor Lionbridge Date: Fri, 11 Aug 2017 19:11:29 +0530 Subject: [PATCH] Review data-control API cs files Change-Id: If53b11efc2583b9458471a76cdf3ec6ec30f980f --- .../Tizen.Applications.DataControl/BulkData.cs | 40 ++--- .../Tizen.Applications.DataControl/Consumer.cs | 176 ++++++++++----------- .../Tizen.Applications.DataControl/ICursor.cs | 12 +- .../Tizen.Applications.DataControl/MatrixCursor.cs | 40 ++--- .../Tizen.Applications.DataControl/Provider.cs | 52 +++--- .../Tizen.Applications.DataControl/Results.cs | 84 +++++----- .../Tizen.Applications.DataControl/Types.cs | 38 ++--- 7 files changed, 221 insertions(+), 221 deletions(-) diff --git a/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/BulkData.cs b/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/BulkData.cs index a3aa164..74dd11f 100755 --- a/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/BulkData.cs +++ b/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/BulkData.cs @@ -19,7 +19,7 @@ using System.Collections.Generic; namespace Tizen.Applications.DataControl { /// - /// Represents BulkData class for DataControl bulk request. + /// Represents the BulkData class for the DataControl bulk request. /// public class BulkData : IDisposable { @@ -27,7 +27,7 @@ namespace Tizen.Applications.DataControl private Interop.DataControl.SafeBulkDataHandle _handle; /// - /// Initializes BulkData class. + /// Initializes the BulkData class. /// /// Thrown in case of any internal error. public BulkData() @@ -80,10 +80,10 @@ namespace Tizen.Applications.DataControl } /// - /// Adds bulk data. + /// Adds the bulk data. /// /// Bulk data - /// Thrown in case of Invalid parmaeter. + /// Thrown in case of an invalid parameter. public void Add(Bundle data) { ResultType ret; @@ -101,7 +101,7 @@ namespace Tizen.Applications.DataControl } /// - /// Gets current data count. + /// Gets the current data count. /// public int GetCount() { @@ -120,8 +120,8 @@ namespace Tizen.Applications.DataControl /// /// Returns the data at the given zero-based data index. /// - /// Target data index - /// Thrown in case of Invalid parmaeter. + /// The target data index. + /// Thrown in case of an invalid parameter. public Bundle GetData(int index) { IntPtr bundlePtr; @@ -144,7 +144,7 @@ namespace Tizen.Applications.DataControl } /// - /// Releases all resources used by the BulkData class. + /// Releases all the resources used by the BulkData class. /// public void Dispose() { @@ -176,7 +176,7 @@ namespace Tizen.Applications.DataControl } /// - /// Represents BulkResultData class for DataControl bulk request. + /// Represents the BulkResultData class for the DataControl bulk request. /// public class BulkResultData : IDisposable { @@ -184,7 +184,7 @@ namespace Tizen.Applications.DataControl private bool _disposed = false; private Interop.DataControl.SafeBulkResultDataHandle _handle; /// - /// Initializes BulkResultData class. + /// Initializes the BulkResultData class. /// /// Thrown in case of any internal error. public BulkResultData() @@ -232,11 +232,11 @@ namespace Tizen.Applications.DataControl } /// - /// Adds bulk operation result data. + /// Adds the bulk operation result data. /// - /// Result data - /// Result - /// Thrown in case of Invalid parmaeter. + /// The result data. + /// Result. + /// Thrown in case of an invalid parameter. public void Add(Bundle data, int result) { ResultType ret; @@ -259,7 +259,7 @@ namespace Tizen.Applications.DataControl } /// - /// Gets current result data count. + /// Gets the current result data count. /// public int GetCount() { @@ -278,8 +278,8 @@ namespace Tizen.Applications.DataControl /// /// Returns the result data at the given zero-based data index. /// - /// Target result data index - /// Thrown in case of Invalid parmaeter. + /// The target result data index. + /// Thrown in case of an invalid parameter. public Bundle GetData(int index) { IntPtr bundlePtr; @@ -305,8 +305,8 @@ namespace Tizen.Applications.DataControl /// /// Returns the result at the given zero-based data index. /// - /// Target result index - /// Thrown in case of Invalid parmaeter. + /// The target result index. + /// Thrown in case of an invalid parameter. public int GetResult(int index) { IntPtr bundlePtr; @@ -328,7 +328,7 @@ namespace Tizen.Applications.DataControl } /// - /// Releases all resources used by the BulkResultData class. + /// Releases all the resources used by the BulkResultData class. /// public void Dispose() { diff --git a/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/Consumer.cs b/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/Consumer.cs index ddbf6a8..7811d15 100755 --- a/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/Consumer.cs +++ b/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/Consumer.cs @@ -21,7 +21,7 @@ using System.Threading; namespace Tizen.Applications.DataControl { /// - /// Represents Consumer class for DataControl consumer application. + /// Represents the Consumer class for the DataControl consumer application. /// public abstract class Consumer : IDisposable { @@ -443,13 +443,13 @@ namespace Tizen.Applications.DataControl } /// - /// Sends insert request to provider application. + /// Sends the insert request to the provider application. /// - /// OnInsertResult will recieve result of this API - /// Insert data - /// Thrown in case of Invalid parmaeter. - /// Thrown in case of permission denied. - /// Thrown when message has exceeded the maximum limit(1MB) + /// The OnInsertResult will recieve the result of this API. + /// The insert data. + /// Thrown in case of an invalid parmaeter. + /// Thrown in case if a permission is denied. + /// Thrown when the message has exceeded the maximum limit (1MB). /// Thrown in case of any internal error. /// http://tizen.org/privilege/datasharing /// http://tizen.org/privilege/appmanager.launch @@ -475,16 +475,16 @@ namespace Tizen.Applications.DataControl } /// - /// Sends select request to provider application. + /// Sends the select request to the provider application. /// - /// OnSelectResult will recieve result of this API - /// Select target column list - /// Where statement for select query - /// Order statement for select query - /// Select target page number - /// Select row count per page - /// Thrown in case of Invalid parmaeter. - /// Thrown in case of permission denied. + /// The OnSelectResult will recieve the result of this API. + /// Select the target column list. + /// The Where statement for the select query. + /// The Order statement for the select query. + /// Select the target page number. + /// Select the row count per page. + /// Thrown in case of an invalid parmaeter. + /// Thrown in case if a permission is denied.. /// Thrown in case of any internal error. /// http://tizen.org/privilege/datasharing /// http://tizen.org/privilege/appmanager.launch @@ -518,11 +518,11 @@ namespace Tizen.Applications.DataControl } /// - /// Sends delete request to provider application. + /// Sends the delete request to the provider application. /// - /// OnDeleteResult will recieve result of this API - /// Where statement for delete query - /// Thrown in case of permission denied. + /// The OnDeleteResult will recieve the result of this API + /// The Where statement for the delete query. + /// Thrown in case if a permission is denied. /// Thrown in case of any internal error. /// http://tizen.org/privilege/datasharing /// http://tizen.org/privilege/appmanager.launch @@ -543,14 +543,14 @@ namespace Tizen.Applications.DataControl } /// - /// Sends update request to provider application. + /// Sends the update request to the provider application. /// - /// OnUpdateResult will recieve result of this API - /// Update data - /// Where statement for query - /// Thrown in case of Invalid parmaeter. - /// Thrown in case of permission denied. - /// Thrown when message has exceeded the maximum limit(1MB) + /// The OnUpdateResult will recieve result of this API. + /// The update data. + /// The Where statement for the query. + /// Thrown in case of an invalid parmaeter. + /// Thrown in case if a permission is denied. + /// Thrown when the message has exceeded the maximum limit (1MB). /// Thrown in case of any internal error. /// http://tizen.org/privilege/datasharing /// http://tizen.org/privilege/appmanager.launch @@ -581,13 +581,13 @@ namespace Tizen.Applications.DataControl } /// - /// Sends bulk insert request to provider application. + /// Sends the bulk insert request to the provider application. /// - /// OnBulkInsertResult will recieve result of this API - /// Bulk insert data - /// Thrown in case of Invalid parmaeter. - /// Thrown in case of permission denied. - /// Thrown when message has exceeded the maximum limit(1MB) + /// The OnBulkInsertResult will recieve the result of this API. + /// The bulk insert data. + /// Thrown in case of an invalid parmaeter. + /// Thrown in case oif a permission is denied. + /// Thrown when the message has exceeded the maximum limit (1MB). /// Thrown in case of any internal error. /// http://tizen.org/privilege/datasharing /// http://tizen.org/privilege/appmanager.launch @@ -613,14 +613,14 @@ namespace Tizen.Applications.DataControl } /// - /// Sends map add request to provider application. + /// Sends the map add request to the provider application. /// - /// OnMapAddResult will recieve result of this API - /// The key of the value to add - /// The value to add - /// Thrown in case of Invalid parmaeter. - /// Thrown in case of permission denied. - /// Thrown when message has exceeded the maximum limit(1MB) + /// The OnMapAddResult will recieve the result of this API. + /// The key of the value to add. + /// The value to add. + /// Thrown in case of an invalid parmaeter. + /// Thrown in case of if a permission is denied. + /// Thrown when the message has exceeded the maximum limit (1MB). /// Thrown in case of any internal error. /// http://tizen.org/privilege/datasharing /// http://tizen.org/privilege/appmanager.launch @@ -646,14 +646,14 @@ namespace Tizen.Applications.DataControl } /// - /// Sends map get request to provider application. + /// Sends the map get request to the provider application. /// - /// OnMapGetResult will recieve result of this API - /// The key of the value list to obtain - /// The page number of the value set - /// The desired maximum count of the data items per page - /// Thrown in case of Invalid parmaeter. - /// Thrown in case of permission denied. + /// The OnMapGetResult will recieve the result of this API. + /// The key of the value list to obtain. + /// The page number of the value set. + /// The desired maximum count of the data items per page. + /// Thrown in case of an invalid parmaeter. + /// Thrown in case if a permission is denied. /// Thrown in case of any internal error. /// http://tizen.org/privilege/datasharing /// http://tizen.org/privilege/appmanager.launch @@ -679,13 +679,13 @@ namespace Tizen.Applications.DataControl } /// - /// Sends map remove request to provider application. + /// Sends the map remove request to the provider application. /// - /// OnMapRemoveResult will recieve result of this API - /// The key of the value to remove - /// The value to remove - /// Thrown in case of Invalid parmaeter. - /// Thrown in case of permission denied. + /// The OnMapRemoveResult will recieve the result of this API. + /// The key of the value to remove. + /// The value to remove. + /// Thrown in case of an invalid parmaeter. + /// Thrown in case if a permission is denied. /// Thrown in case of any internal error. /// http://tizen.org/privilege/datasharing /// http://tizen.org/privilege/appmanager.launch @@ -711,15 +711,15 @@ namespace Tizen.Applications.DataControl } /// - /// Sends map set request to provider application. + /// Sends the map set request to the provider application. /// - /// OnMapSetResult will recieve result of this API - /// The key of the value to replace - /// The value to be replaced - /// The new value that replaces the existing value - /// Thrown in case of Invalid parmaeter. - /// Thrown in case of permission denied. - /// Thrown when message has exceeded the maximum limit(1MB) + /// The OnMapSetResult will recieve the result of this API. + /// The key of the value to replace. + /// The value to be replaced. + /// The new value that replaces the existing value. + /// Thrown in case of an invalid parmaeter. + /// Thrown in case if a permission is denied. + /// Thrown when message has exceeded the maximum limit (1MB). /// Thrown in case of any internal error. /// http://tizen.org/privilege/datasharing /// http://tizen.org/privilege/appmanager.launch @@ -745,13 +745,13 @@ namespace Tizen.Applications.DataControl } /// - /// Sends map bulk add request to provider application. + /// Sends the map bulk add request to the provider application. /// - /// OnMapBulkAddResult will recieve result of this API - /// Map bulk add data - /// Thrown in case of Invalid parmaeter. - /// Thrown in case of permission denied. - /// Thrown when message has exceeded the maximum limit(1MB) + /// The OnMapBulkAddResult will recieve the result of this API. + /// The map bulk add data. + /// Thrown in case of an invalid parmaeter. + /// Thrown in case if a permission is denied. + /// Thrown when the message has exceeded the maximum limit (1MB). /// Thrown in case of any internal error. /// http://tizen.org/privilege/datasharing /// http://tizen.org/privilege/appmanager.launch @@ -787,11 +787,11 @@ namespace Tizen.Applications.DataControl } /// - /// Listen DataChange event + /// Listens the DataChange event. /// - /// OnDataChangeListenResult will recieve result of this API - /// If success, OnDataChange will recieve DataChange event - /// Thrown in case of permission denied. + /// The OnDataChangeListenResult will recieve the result of this API. + /// If success, the OnDataChange will recieve the DataChange event. + /// Thrown in case if a permission is denied. /// Thrown in case of any internal error. /// http://tizen.org/privilege/datasharing /// http://tizen.org/privilege/appmanager.launch @@ -817,11 +817,11 @@ namespace Tizen.Applications.DataControl } /// - /// Initializes Consumer class with providerId and dataId. + /// Initializes the Consumer class with the providerId and the ataId. /// - /// DataControl Provider ID - /// DataControl Data ID - /// Thrown in case of Invalid parmaeter. + /// The DataControl Provider ID. + /// The DataControl Data ID. + /// Thrown in case of an invalid parmaeter. /// Thrown in case of any internal error. public Consumer(string providerId, string dataId) { @@ -856,7 +856,7 @@ namespace Tizen.Applications.DataControl } /// - /// Overrides this method if want to handle behavior when the DataChangeListen result is received. + /// Overrides this method if you want to handle the behavior when the DataChangeListen result is received. /// protected virtual void OnDataChangeListenResult(DataChangeListenResult result) { @@ -864,7 +864,7 @@ namespace Tizen.Applications.DataControl } /// - /// Overrides this method if want to handle behavior when the data change event is received. + /// Overrides this method if you want to handle the behavior when the data change event is received. /// protected virtual void OnDataChange(ChangeType type, Bundle data) { @@ -872,26 +872,26 @@ namespace Tizen.Applications.DataControl } /// - /// Overrides this method if want to handle behavior when the select response is received. + /// Overrides this method if you want to handle the behavior when the select response is received. /// protected abstract void OnSelectResult(SelectResult result); /// - /// Overrides this method if want to handle behavior when the insert response is received. + /// Overrides this method if you want to handle the behavior when the insert response is received. /// protected abstract void OnInsertResult(InsertResult result); /// - /// Overrides this method if want to handle behavior when the update response is received. + /// Overrides this method if you want to handle the behavior when the update response is received. /// protected abstract void OnUpdateResult(UpdateResult result); /// - /// Overrides this method if want to handle behavior when the delete response is received. + /// Overrides this method if want to handle the behavior when the delete response is received. /// protected abstract void OnDeleteResult(DeleteResult result); /// - /// Overrides this method if want to handle behavior when the BulkInsert response is received. + /// Overrides this method if you want to handle the behavior when the BulkInsert response is received. /// protected virtual void OnBulkInsertResult(BulkInsertResult result) { @@ -899,7 +899,7 @@ namespace Tizen.Applications.DataControl } /// - /// Overrides this method if want to handle behavior when the map get response is received. + /// Overrides this method if you want to handle the behavior when the map get response is received. /// protected virtual void OnMapGetResult(MapGetResult result) { @@ -907,7 +907,7 @@ namespace Tizen.Applications.DataControl } /// - /// Overrides this method if want to handle behavior when the map add response is received. + /// Overrides this method if you want to handle the behavior when the map add response is received. /// protected virtual void OnMapAddResult(MapAddResult result) { @@ -915,7 +915,7 @@ namespace Tizen.Applications.DataControl } /// - /// Overrides this method if want to handle behavior when the map set response is received. + /// Overrides this method if you want to handle the behavior when the map set response is received. /// protected virtual void OnMapSetResult(MapSetResult result) { @@ -923,7 +923,7 @@ namespace Tizen.Applications.DataControl } /// - /// Overrides this method if want to handle behavior when the map remove response is received. + /// Overrides this method if you want to handle the behavior when the map remove response is received. /// protected virtual void OnMapRemoveResult(MapRemoveResult result) { @@ -931,7 +931,7 @@ namespace Tizen.Applications.DataControl } /// - /// Overrides this method if want to handle behavior when the BulkAdd response is received. + /// Overrides this method if you want to handle the behavior when the BulkAdd response is received. /// protected virtual void OnMapBulkAddResult(MapBulkAddResult result) { @@ -939,7 +939,7 @@ namespace Tizen.Applications.DataControl } /// - /// Releases the unmanaged resourced used by the Consumer class specifying whether to perform a normal dispose operation. + /// Releases the unmanaged resources used by the Consumer class specifying whether to perform a normal dispose operation. /// /// true for a normal dispose operation; false to finalize the handle. protected virtual void Dispose(bool disposing) diff --git a/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/ICursor.cs b/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/ICursor.cs index 4136358..0843ceb 100755 --- a/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/ICursor.cs +++ b/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/ICursor.cs @@ -18,7 +18,7 @@ using System; namespace Tizen.Applications.DataControl { /// - /// This interface is for DataControl cursor. + /// This interface is for the DataControl cursor. /// public interface ICursor { @@ -53,27 +53,27 @@ namespace Tizen.Applications.DataControl /// bool Reset(); /// - /// / Gets an int value. + /// Gets an integer value. /// /// The index of row. int GetIntValue(int index); /// - /// / Gets an int64 value. + /// Gets an int64 value. /// /// The index of row. Int64 GetInt64Value(int index); /// - /// Gets an double value. + /// Gets a double value. /// /// The index of row. double GetDoubleValue(int index); /// - /// Gets an string value. + /// Gets a string value. /// /// The index of row. string GetStringValue(int index); /// - /// Gets a blob value. + /// Gets a BLOB value. /// /// The index of row. byte[] GetBlobValue(int index); diff --git a/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/MatrixCursor.cs b/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/MatrixCursor.cs index 426416e..2df5c7b 100755 --- a/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/MatrixCursor.cs +++ b/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/MatrixCursor.cs @@ -24,7 +24,7 @@ using System.Diagnostics; namespace Tizen.Applications.DataControl { /// - /// Represents MatrixCursor class for DataControl provider's matrix cursor. + /// Represents the MatrixCursor class for the DataControl provider's matrix cursor. /// public class MatrixCursor : IDisposable, ICursor { @@ -164,7 +164,7 @@ namespace Tizen.Applications.DataControl } /// - /// Gets column count of MatrixCursor. + /// Gets the column count of the MatrixCursor. /// public int GetColumnCount() { @@ -175,7 +175,7 @@ namespace Tizen.Applications.DataControl /// Returns the column type at the given zero-based column index. /// /// Target column index - /// Thrown in case of Invalid parmaeter. + /// Thrown in case of an invalid parameter. public ColumnType GetColumnType(int index) { if (index < 0 || index >= _columnTypes.Length) @@ -189,8 +189,8 @@ namespace Tizen.Applications.DataControl /// /// Returns the column name at the given zero-based column index. /// - /// Target column index - /// Thrown in case of Invalid parmaeter. + /// The target column index. + /// Thrown in case of an invalid parameter. public string GetColumnName(int index) { if (index < 0 || index >= _columnTypes.Length) @@ -202,7 +202,7 @@ namespace Tizen.Applications.DataControl } /// - /// Gets MatrixCursor's row count. + /// Gets the MatrixCursor's row count. /// public long GetRowCount() { @@ -247,9 +247,9 @@ namespace Tizen.Applications.DataControl } /// - /// Returns the value of the requested column as a int. + /// Returns the value of the requested column as an integer. /// - /// Thrown in case of Invalid parmaeter. + /// Thrown in case of an invalid parameter. public int GetIntValue(int index) { int ret; @@ -271,9 +271,9 @@ namespace Tizen.Applications.DataControl } /// - /// Returns the value of the requested column as a int64. + /// Returns the value of the requested column as int64. /// - /// Thrown in case of Invalid parmaeter. + /// Thrown in case of an invalid parameter. public Int64 GetInt64Value(int index) { Int64 ret; @@ -297,7 +297,7 @@ namespace Tizen.Applications.DataControl /// /// Returns the value of the requested column as a double. /// - /// Thrown in case of Invalid parmaeter. + /// Thrown in case of an invalid parameter. public double GetDoubleValue(int index) { double ret; @@ -321,7 +321,7 @@ namespace Tizen.Applications.DataControl /// /// Returns the value of the requested column as a string. /// - /// Thrown in case of Invalid parmaeter. + /// Thrown in case of an invalid parameter. public string GetStringValue(int index) { string ret; @@ -345,9 +345,9 @@ namespace Tizen.Applications.DataControl } /// - /// Returns the value of the requested column as a blob. + /// Returns the value of the requested column as a BLOB. /// - /// Thrown in case of Invalid parmaeter. + /// Thrown in case of an invalid parameter. public byte[] GetBlobValue(int index) { byte[] byte_array; @@ -392,11 +392,11 @@ namespace Tizen.Applications.DataControl } /// - /// Initializes MatrixCursor class with columnNames and columnTypes. + /// Initializes the MatrixCursor class with columnNames and columnTypes. /// - /// MatrixCursor's column name list - /// MatrixCursor's column type list - /// Thrown in case of Invalid parmaeter. + /// The MatrixCursor's column name list. + /// The MatrixCursor's column type list. + /// Thrown in case of an invalid parameter. /// Thrown in case of any internal error. public MatrixCursor(string[] columnNames, ColumnType[] columnTypes) { @@ -485,7 +485,7 @@ namespace Tizen.Applications.DataControl /// Adds a new row to the end with the given column values. /// /// New column values - /// Thrown in case of Invalid parmaeter. + /// Thrown in case of an invalid parameter. public void AddRow(object[] columnValues) { int i, size = 0; @@ -586,7 +586,7 @@ namespace Tizen.Applications.DataControl } /// - /// Releases all resources used by the MatrixCursor class. + /// Releases all the resources used by the MatrixCursor class. /// public void Dispose() { diff --git a/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/Provider.cs b/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/Provider.cs index 72a1142..c99702e 100755 --- a/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/Provider.cs +++ b/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/Provider.cs @@ -24,7 +24,7 @@ using System.Threading; namespace Tizen.Applications.DataControl { /// - /// Represents Provider class for DataControl provider application. + /// Represents the Provider class for the DataControl provider application. /// public abstract class Provider : IDisposable { @@ -43,7 +43,7 @@ namespace Tizen.Applications.DataControl private bool _isRunning = false; /// - /// Gets the data ID + /// Gets the data ID. /// public string DataID { @@ -834,10 +834,10 @@ namespace Tizen.Applications.DataControl /// /// Sends a data change notification to consumer applications which have successfully added a data change listen. /// - /// Changed data type - /// Customized information about changed data - /// Thrown in case of Invalid parmaeter. - /// Thrown in case of permission denied. + /// The changed data type. + /// Customized information about the changed data. + /// Thrown in case of an invalid parameter. + /// Thrown in case a permission is denied. /// Thrown in case of any internal error. /// http://tizen.org/privilege/datasharing public void SendDataChange(ChangeType type, Bundle changedData) @@ -862,10 +862,10 @@ namespace Tizen.Applications.DataControl } /// - /// Initializes Provider class with dataID. + /// Initializes the Provider class with the dataID. /// - /// DataControl Data ID - /// Thrown in case of Invalid parmaeter. + /// The DataControl Data ID. + /// Thrown in case of an invalid parameter. public Provider(string dataID) { if (string.IsNullOrEmpty(dataID)) @@ -877,10 +877,10 @@ namespace Tizen.Applications.DataControl } /// - /// Starts Provider service. + /// Starts the Provider service. /// - /// Only one Provider service can be ran for each process - /// Thrown in case of permission denied. + /// Only one Provider service can be run for each process. + /// Thrown in case a permission is denied. /// Thrown in case of any internal error. /// http://tizen.org/privilege/datasharing public void Run() @@ -963,7 +963,7 @@ namespace Tizen.Applications.DataControl } /// - /// Stop Provider service. + /// Stops the Provider service. /// public void Stop() { @@ -981,27 +981,27 @@ namespace Tizen.Applications.DataControl } /// - /// Overrides this method if want to handle behavior when the select request is received. + /// Overrides this method if you want to handle the behavior when the select request is received. /// protected abstract SelectResult OnSelect(string query, string where, string[] columList, int columnCount, string order, int pageNum, int countPerPage); /// - /// Overrides this method if want to handle behavior when the insert request is received. + /// Overrides this method if you want to handle the behavior when the insert request is received. /// protected abstract InsertResult OnInsert(string query, Bundle insertData); /// - /// Overrides this method if want to handle behavior when the update request is received. + /// Overrides this method if you want to handle the behavior when the update request is received. /// protected abstract UpdateResult OnUpdate(string query, string where, Bundle updateData); /// - /// Overrides this method if want to handle behavior when the delete request is received. + /// Overrides this method if you want to handle the behavior when the delete request is received. /// protected abstract DeleteResult OnDelete(string query, string where); /// - /// Overrides this method if want to handle behavior when the bulk insert request is received. + /// Overrides this method if you want to handle the behavior when the bulk insert request is received. /// protected virtual BulkInsertResult OnBulkInsert(IEnumerable query, BulkData bulkInsertData) { @@ -1010,7 +1010,7 @@ namespace Tizen.Applications.DataControl } /// - /// Overrides this method if want to handle behavior when the map get request is received. + /// Overrides this method if you want to handle the behavior when the map get request is received. /// protected virtual MapGetResult OnMapGet(string key) { @@ -1019,7 +1019,7 @@ namespace Tizen.Applications.DataControl } /// - /// Overrides this method if want to handle behavior when the map add request is received. + /// Overrides this method if you want to handle the behavior when the map add request is received. /// protected virtual MapAddResult OnMapAdd(string key, string value) { @@ -1028,7 +1028,7 @@ namespace Tizen.Applications.DataControl } /// - /// Overrides this method if want to handle behavior when the update request is received. + /// Overrides this method if you want to handle the behavior when the update request is received. /// protected virtual MapSetResult OnMapSet(string key, string oldValue, string newValue) { @@ -1037,7 +1037,7 @@ namespace Tizen.Applications.DataControl } /// - /// Overrides this method if want to handle behavior when the delete request is received. + /// Overrides this method if you want to handle the behavior when the delete request is received. /// protected virtual MapRemoveResult OnMapRemove(string key, string value) { @@ -1046,7 +1046,7 @@ namespace Tizen.Applications.DataControl } /// - /// Overrides this method if want to handle behavior when the bulk add request is received. + /// Overrides this method if you want to handle the behavior when the bulk add request is received. /// protected virtual MapBulkAddResult OnMapBulkAdd(BulkData bulkAddData) { @@ -1055,7 +1055,7 @@ namespace Tizen.Applications.DataControl } /// - /// Overrides this method if want to handle behavior when the data change listen request is received. + /// Overrides this method if you want to handle the behavior when the data change listen request is received. /// protected virtual DataChangeListenResult OnDataChangeListenRequest(string requestAppID) { @@ -1064,7 +1064,7 @@ namespace Tizen.Applications.DataControl } /// - /// Releases the unmanaged resourced used by the Provider class specifying whether to perform a normal dispose operation. + /// Releases unmanaged resources used by the Provider class specifying whether to perform a normal dispose operation. /// /// true for a normal dispose operation; false to finalize the handle. protected virtual void Dispose(bool disposing) @@ -1081,7 +1081,7 @@ namespace Tizen.Applications.DataControl } /// - /// Releases all resources used by the Provider class. + /// Releases all the resources used by the Provider class. /// public void Dispose() { diff --git a/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/Results.cs b/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/Results.cs index 81f63a5..f61c226 100755 --- a/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/Results.cs +++ b/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/Results.cs @@ -19,12 +19,12 @@ using System; namespace Tizen.Applications.DataControl { /// - /// This class is for containing insert operation result. + /// This class contains the insert operation result. /// public class InsertResult { /// - /// Gets the insert data's row id. + /// Gets the insert data's row ID. /// public long RowID { @@ -42,10 +42,10 @@ namespace Tizen.Applications.DataControl } /// - /// Initializes InsertResult class with columnNames and columnTypes. + /// Initializes the InsertResult class with columnNames and columnTypes. /// - /// Inserted row ID - /// Insert request result + /// The inserted row ID. + /// The insert request result. public InsertResult(long rowID, bool result) { RowID = rowID; @@ -54,7 +54,7 @@ namespace Tizen.Applications.DataControl } /// - /// This class is for containing bulk insert operation result. + /// This class contains the bulk insert operation result. /// public class BulkInsertResult { @@ -77,11 +77,11 @@ namespace Tizen.Applications.DataControl } /// - /// Initializes InsertResult class with bulkResultData and result. + /// Initializes the InsertResult class with the bulkResultData and the result. /// - /// Bulk insert request result data - /// Bulk insert request result - /// Thrown in case of Invalid parmaeter. + /// The bulk insert request result data. + /// The bulk insert request result. + /// Thrown in case of an invalid parameter. public BulkInsertResult(BulkResultData bulkResultData, bool result) { if (result == true && (bulkResultData == null || bulkResultData.SafeBulkDataHandle.IsInvalid)) @@ -95,7 +95,7 @@ namespace Tizen.Applications.DataControl } /// - /// This class is for containing update operation result. + /// This class contains the update operation result. /// public class UpdateResult { @@ -109,9 +109,9 @@ namespace Tizen.Applications.DataControl } /// - /// Initializes UpdateResult class with result. + /// Initializes the UpdateResult class with the result. /// - /// Update request result + /// The update request result. public UpdateResult(bool result) { Result = result; @@ -119,7 +119,7 @@ namespace Tizen.Applications.DataControl } /// - /// This class is for containing delete operation result. + /// This class contains the delete operation result. /// public class DeleteResult { @@ -133,9 +133,9 @@ namespace Tizen.Applications.DataControl } /// - /// Initializes DeleteResult class with result. + /// Initializes the DeleteResult class with the result. /// - /// Delete request result + /// The delete request result. public DeleteResult(bool result) { Result = result; @@ -143,7 +143,7 @@ namespace Tizen.Applications.DataControl } /// - /// This class is for containing select operation result. + /// This class contains the select operation result. /// public class SelectResult { @@ -165,11 +165,11 @@ namespace Tizen.Applications.DataControl } /// - /// Initializes SelectResult class with cursor and result. + /// Initializes the SelectResult class with the cursor and the result. /// - /// Cursor with selected data - /// Select request result - /// Thrown in case of Invalid parmaeter. + /// The cursor with the selected data. + /// The select request result. + /// Thrown in case of an invalid parameter. public SelectResult(ICursor cursor, bool result) { int i; @@ -206,7 +206,7 @@ namespace Tizen.Applications.DataControl } /// - /// This class is for containing MapAdd operation result. + /// This class contains the MapAdd operation result. /// public class MapAddResult { @@ -221,9 +221,9 @@ namespace Tizen.Applications.DataControl } /// - /// Initializes MapAddResult class with result. + /// Initializes the MapAddResult class with the result. /// - /// MapAdd request result + /// The MapAdd request result. public MapAddResult(bool result) { Result = result; @@ -231,7 +231,7 @@ namespace Tizen.Applications.DataControl } /// - /// This class is for containing MapBulkAdd operation result. + /// This class contains the MapBulkAdd operation result. /// public class MapBulkAddResult { @@ -254,11 +254,11 @@ namespace Tizen.Applications.DataControl } /// - /// Initializes MapBulkAddResult class with bulkResultData and result. + /// Initializes the MapBulkAddResult class with the bulkResultData and the result. /// - /// MapBulkAdd request result data - /// MapBulkAdd request result - /// Thrown in case of Invalid parmaeter. + /// The MapBulkAdd request result data. + /// The MapBulkAdd request result. + /// Thrown in case of an invalid parameter. public MapBulkAddResult(BulkResultData bulkResultData, bool result) { if (result == true && (bulkResultData == null || bulkResultData.SafeBulkDataHandle.IsInvalid)) @@ -272,7 +272,7 @@ namespace Tizen.Applications.DataControl } /// - /// This class is for containing MapSet operation result. + /// This class contains the MapSet operation result. /// public class MapSetResult { @@ -286,7 +286,7 @@ namespace Tizen.Applications.DataControl } /// - /// Initializes MapSetResult class with result. + /// Initializes the MapSetResult class with the result. /// /// MapSet request result public MapSetResult(bool result) @@ -296,7 +296,7 @@ namespace Tizen.Applications.DataControl } /// - /// This class is for containing MapRemove operation result. + /// This class contains the MapRemove operation result. /// public class MapRemoveResult { @@ -310,9 +310,9 @@ namespace Tizen.Applications.DataControl } /// - /// Initializes MapRemoveResult class with result. + /// Initializes the MapRemoveResult class with the result. /// - /// MapRemove request result + /// The MapRemove request result. public MapRemoveResult(bool result) { Result = result; @@ -320,7 +320,7 @@ namespace Tizen.Applications.DataControl } /// - /// This class is for containing MapGet operation result. + /// This class contains the MapGet operation result. /// public class MapGetResult { @@ -342,11 +342,11 @@ namespace Tizen.Applications.DataControl } /// - /// Initializes MapGetResult class with data and result. + /// Initializes the MapGetResult class with the data and the result. /// - /// MapGet request result data - /// MapGet request result - /// Thrown in case of Invalid parmaeter. + /// The MapGet request result data. + /// The MapGet request result. + /// Thrown in case of an invalid parameter. public MapGetResult(string[] valueLIst, bool result) { if (result == true && valueLIst == null) @@ -360,7 +360,7 @@ namespace Tizen.Applications.DataControl } /// - /// This class is for containing DataChangeListen operation result. + /// This class contains the DataChangeListen operation result. /// public class DataChangeListenResult { @@ -374,9 +374,9 @@ namespace Tizen.Applications.DataControl } /// - /// Initializes DataChangeListenResult class with result. + /// Initializes the DataChangeListenResult class with the result. /// - /// DataChangeListen request result + /// The DataChangeListen request result. public DataChangeListenResult(ResultType result) { Result = result; diff --git a/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/Types.cs b/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/Types.cs index 09d25a6..6b4749f 100755 --- a/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/Types.cs +++ b/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/Types.cs @@ -20,86 +20,86 @@ namespace Tizen.Applications.DataControl { /// - /// Enumeration for DataControl column type + /// Enumeration for the DataControl column types. /// public enum ColumnType : short { /// - /// Value representing DataControl operation Success + /// Value representing DataControl operation success. /// ColumnTypeInt = 1, /// - /// Value representing DataControl operation Success + /// Value representing DataControl operation success. /// ColumnTypeDouble = 2, /// - /// Value representing DataControl operation Success + /// Value representing DataControl operation success. /// ColumnTypeString = 3, /// - /// Value representing DataControl operation Success + /// Value representing DataControl operation success. /// ColumnTypeBlob = 4 } /// - /// Enumeration for DataControl column type + /// Enumeration for the DataControl column types. /// public enum ChangeType : short { /// - /// Value representing DataControl provider data changed by update + /// Value representing DataControl provider data changed by update. /// Update, /// - /// Value representing DataControl provider data changed by insert + /// Value representing DataControl provider data changed by insert. /// Insert, /// - /// Value representing DataControl provider data changed by delete + /// Value representing DataControl provider data changed by delete. /// Delete, /// - /// Value representing DataControl provider data changed by map add + /// Value representing DataControl provider data changed by map add. /// MapAdd, /// - /// Value representing DataControl provider data changed by map remove + /// Value representing DataControl provider data changed by map remove. /// MapRemove, /// - /// Value representing DataControl provider data changed by map set + /// Value representing DataControl provider data changed by map set. /// MapSet, } /// - /// Enumeration for DataControl result type + /// Enumeration for the DataControl result types. /// public enum ResultType : int { /// - /// Value representing DataControl operation success + /// Value representing DataControl operation success. /// Success = Interop.DataControl.NativeResultType.Success, /// - /// Value representing DataControl operation cause out of memory error + /// Value representing DataControl operation causing out of memory error. /// OutOfMemory = Interop.DataControl.NativeResultType.OutOfMemory, /// - /// Value representing DataControl operation cause IO error + /// Value representing DataControl operation causing I/O error. /// IoError = Interop.DataControl.NativeResultType.IoError, /// - /// Value representing DataControl operation cause Invalid parameter error + /// Value representing DataControl operation causing invalid parameter error. /// InvalidParameter = Interop.DataControl.NativeResultType.InvalidParameter, /// - /// Value representing DataControl operation cause permission denied error + /// Value representing DataControl operation causing permission denied error. /// PermissionDenied = Interop.DataControl.NativeResultType.PermissionDenied, /// - /// Value representing DataControl operation cause max exceed error + /// Value representing DataControl operation causing max exceed error. /// MaxExceed = Interop.DataControl.NativeResultType.MaxExceed, } -- 2.7.4