diff options
5 files changed, 58 insertions, 58 deletions
diff --git a/Tizen.Account.SyncManager/Interop/Interop.Libraries.cs b/Tizen.Account.SyncManager/Interop/Interop.Libraries.cs index 837e50b..a1d3410 100755 --- a/Tizen.Account.SyncManager/Interop/Interop.Libraries.cs +++ b/Tizen.Account.SyncManager/Interop/Interop.Libraries.cs @@ -17,7 +17,7 @@ internal static partial class Interop { /// <summary> - /// Wrapper class for maintaining names of dependent native libraries. + /// The Wrapper class for maintaining names of dependent native libraries. /// </summary> internal static partial class Libraries { diff --git a/Tizen.Account.SyncManager/Tizen.Account.SyncManager/Enumerations.cs b/Tizen.Account.SyncManager/Tizen.Account.SyncManager/Enumerations.cs index 4befba6..7bfb265 100755 --- a/Tizen.Account.SyncManager/Tizen.Account.SyncManager/Enumerations.cs +++ b/Tizen.Account.SyncManager/Tizen.Account.SyncManager/Enumerations.cs @@ -19,64 +19,64 @@ using System; namespace Tizen.Account.SyncManager { /// <summary> - /// Enumeration for the Sync option + /// Enumeration for the sync option. /// </summary> [Flags] public enum SyncOption { /// <summary> - /// Sync job will be operated normally + /// The sync job will be operated normally. /// </summary> None = 0, /// <summary> - /// Sync job will be operated as soon as possible + /// The sync job will be operated as soon as possible. /// </summary> Expedited = 0X01, /// <summary> - /// Sync job will not be performed again when it fails + /// The sync job will not be performed again when it fails. /// </summary> NoRetry = 0X02, } /// <summary> - /// Enumeration for the Sync period + /// Enumeration for the sync period. /// </summary> public enum SyncPeriod { /// <summary> - /// Sync within 30 minutes + /// Sync within 30 minutes. /// </summary> ThirtyMin = 0, /// <summary> - /// Sync within 1 hour + /// Sync within 1 hour. /// </summary> OneHour, /// <summary> - /// Sync within 2 hours + /// Sync within 2 hours. /// </summary> TwoHours, /// <summary> - /// Sync within 3 hours + /// Sync within 3 hours. /// </summary> ThreeHours, /// <summary> - /// Sync within 6 hours + /// Sync within 6 hours. /// </summary> SixHours, /// <summary> - /// Sync within 12 hours + /// Sync within 12 hours. /// </summary> TwelveHours, /// <summary> - /// Sync within 1 day + /// Sync within 1 day. /// </summary> OneDay, } diff --git a/Tizen.Account.SyncManager/Tizen.Account.SyncManager/SyncAdapter.cs b/Tizen.Account.SyncManager/Tizen.Account.SyncManager/SyncAdapter.cs index 8a59593..4a25dee 100755 --- a/Tizen.Account.SyncManager/Tizen.Account.SyncManager/SyncAdapter.cs +++ b/Tizen.Account.SyncManager/Tizen.Account.SyncManager/SyncAdapter.cs @@ -21,7 +21,7 @@ using Tizen.Account.AccountManager; namespace Tizen.Account.SyncManager { /// <summary> - /// The class contains the delegates to be called upon scheduling a sync operation + /// This class contains the delegates to be called upon scheduling a sync operation. /// </summary> public class SyncAdapter { @@ -29,23 +29,23 @@ namespace Tizen.Account.SyncManager Interop.Adapter.SyncAdapterCancelSyncCallback _cancelSyncCallback; /// <summary> - /// Callback function for Sync Adapter's start sync request + /// The callback function for the sync adapter's start sync request. /// </summary> /// <param name="syncParameters"> The sync job parameters corresponding to the sync request. </param> - /// <returns> true if sync operation is success, @c false otherwise. </returns> + /// <returns> true if the sync operation is success, @c false otherwise. </returns> public delegate bool StartSyncCallback(SyncJobData syncParameters); /// <summary> - /// Callback function for Sync Adapter's cancel sync request. + /// The callback function for the sync adapter's cancel sync request. /// </summary> /// <param name="syncParameters"> The sync job parameters corresponding to the sync request. </param> public delegate void CancelSyncCallback(SyncJobData syncParameters); /// <summary> - /// Sets client (Sync Adapter) callback functions + /// Sets the client (sync adapter) callback functions. /// </summary> - /// <param name="startSyncCb"> A callback function to be called by Sync Manager for performing sync operation. </param> - /// <param name="cancelSyncCb"> A callback function to be called by Sync Manager for cancelling sync operation. </param> + /// <param name="startSyncCb"> A callback function to be called by the sync manager for performing the sync operation. </param> + /// <param name="cancelSyncCb"> A callback function to be called by the sync manager for cancelling the sync operation. </param> /// <exception cref="ArgumentNullException"> Thrown when any of the arguments are null. </exception> /// <exception cref="InvalidOperationException"> Thrown when the application calling this API cannot be a sync adapter. </exception> public void SetSyncEventCallbacks(StartSyncCallback startSyncCb, CancelSyncCallback cancelSyncCb) @@ -98,7 +98,7 @@ namespace Tizen.Account.SyncManager } /// <summary> - /// Unsets client (Sync Adapter) callback functions + /// Unsets the client (sync adapter) callback functions. /// </summary> /// <exception cref="System.Exception"> Thrown when sync manager internal error occurs. </exception> public void UnsetSyncEventCallbacks() diff --git a/Tizen.Account.SyncManager/Tizen.Account.SyncManager/SyncClient.cs b/Tizen.Account.SyncManager/Tizen.Account.SyncManager/SyncClient.cs index 4c82b85..f86747b 100755 --- a/Tizen.Account.SyncManager/Tizen.Account.SyncManager/SyncClient.cs +++ b/Tizen.Account.SyncManager/Tizen.Account.SyncManager/SyncClient.cs @@ -23,25 +23,25 @@ namespace Tizen.Account.SyncManager { /// <summary> /// The SyncClient APIs for managing the sync operations. Applications will call these APIs to schedule their sync operations. - /// Sync service maintains sync requests from all the applications and invokes their respective callback methods to perform account synchronization operations. + /// The sync service maintains sync requests from all the applications and invokes their respective callback methods to perform account synchronization operations. /// </summary> public static class SyncClient { /// <summary> - /// The constructor + /// The constructor. /// </summary> static SyncClient() { } /// <summary> - /// Requests Sync Manager to perform one time sync operation + /// Requests the sync manager to perform one time sync operation. /// </summary> - /// <param name="request"> Sync job information of the sync job request. </param> - /// <param name="syncOptions"> sync options determine an way to operate sync job and can be used as ORing. </param> + /// <param name="request"> The sync job information of the sync job request. </param> + /// <param name="syncOptions"> Sync options determine a way to operate the sync job and can be used as ORing. </param> /// <exception cref="ArgumentNullException"> Thrown when any of the arugments are null. </exception> - /// <exception cref="InvalidOperationException"> Thrown when the application calling this api doesn't have a sync adapter. </exception> - /// <returns> A unique value which can manage sync jobs. The number of sync job id is limited as less than a hundred. </returns> + /// <exception cref="InvalidOperationException"> Thrown when the application calling this API doesn't have a sync adapter. </exception> + /// <returns> An unique value which can manage sync jobs. The number of sync job ID is limite as it is less than hundred. </returns> public static int RequestOnDemandSyncJob(SyncJobData request, SyncOption syncOptions) { if (request == null || request.SyncJobName == null) @@ -63,16 +63,16 @@ namespace Tizen.Account.SyncManager } /// <summary> - /// Requests Sync Manager to perform periodic sync operations + /// Requests the sync manager to perform periodic sync operations. /// </summary> - /// <param name="request"> Sync job information of the sync job request. </param> - /// <param name="period"> Determines time interval of periodic sync. The periodic sync operation can be triggered in that interval, but it does not guarantee exact time. The minimum value is 30 minutes. </param> - /// <param name="syncOptions"> sync options determine an way to operate sync job and can be used as ORing. </param> + /// <param name="request"> The sync job information of the sync job request. </param> + /// <param name="period"> Determines the time interval of the periodic sync. The periodic sync operation can be triggered in that interval, but it does not guarantee the exact time. The minimum value is 30 minutes. </param> + /// <param name="syncOptions"> Sync options determine a way to operate the sync job and can be used as ORing. </param> /// <privilege>http://tizen.org/privilege/alarm.set</privilege> - /// <exception cref="UnauthorizedAccessException"> In case of privilege not defined. </exception> + /// <exception cref="UnauthorizedAccessException"> In case of a privilege not defined. </exception> /// <exception cref="ArgumentNullException"> Thrown when any of the arguments are null. </exception> /// <exception cref="InvalidOperationException"> Thrown when the application calling this API doesn't have a sync adapter. </exception> - /// <returns> A unique value which can manage sync jobs. The number of sync job id is limited as less than a hundred. </returns> + /// <returns> A unique value which can manage sync jobs. The number of sync job IDs is limited as it is less than hundred. </returns> public static int AddPeriodicSyncJob(SyncJobData request, SyncPeriod period, SyncOption syncOptions) { if (request == null || request.SyncJobName == null) @@ -94,16 +94,16 @@ namespace Tizen.Account.SyncManager } /// <summary> - /// Requests Sync Manager to perform sync operations whenever corresponding DB changed + /// Requests the sync manager to perform sync operations whenever the corresponding DB is changed. /// </summary> - /// <param name="request"> Sync job information of the sync job request. </param> - /// <param name="syncOptions"> sync options determine an way to operate sync job and can be used as ORing. </param> + /// <param name="request"> The sync job information of the sync job request. </param> + /// <param name="syncOptions"> Sync options determine a way to operate the sync job and can be used as ORing. </param> /// <privilege>http://tizen.org/privilege/calendar.read</privilege> /// <privilege>http://tizen.org/privilege/contact.read</privilege> - /// <exception cref="UnauthorizedAccessException"> In case of privilege not defined. </exception> + /// <exception cref="UnauthorizedAccessException"> In case of a privilege is not defined. </exception> /// <exception cref="ArgumentNullException"> Thrown when any of the arguments are null. </exception> /// <exception cref="InvalidOperationException"> Thrown when the application calling this API doesn't have a sync adapter. </exception> - /// <returns> A unique value which can manage sync jobs. The number of sync job id is limited as less than a hundred. </returns> + /// <returns> A unique value which can manage sync jobs. The number of sync job IDs is limited as it is less than hundred. </returns> public static int AddDataChangeSyncJob(SyncJobData request, SyncOption syncOptions) { if (request == null || request.SyncJobName == null) @@ -125,7 +125,7 @@ namespace Tizen.Account.SyncManager } /// <summary> - /// Get all the sync jobs registered with the sync manager + /// Gets all the sync jobs registered with the sync manager. /// </summary> /// <returns> /// Returns the list of SyncJobData corresponding to sync requests. @@ -160,9 +160,9 @@ namespace Tizen.Account.SyncManager } /// <summary> - /// Requests Sync Manager to remove corresponding sync job job based on id + /// Requests the sync manager to remove the corresponding sync job based on the ID. /// </summary> - /// <param name="id"> A unique value of each sync job, it can be used to search specific sync job and remove it. </param> + /// <param name="id"> A unique value of each sync job, it can be used to search a specific sync job and remove it. </param> /// <exception cref="ArgumentException"> Thrown if the input arugments is invalid. </exception> public static void RemoveSyncJob(int id) { diff --git a/Tizen.Account.SyncManager/Tizen.Account.SyncManager/SyncJobData.cs b/Tizen.Account.SyncManager/Tizen.Account.SyncManager/SyncJobData.cs index 51c2039..e9f88da 100755 --- a/Tizen.Account.SyncManager/Tizen.Account.SyncManager/SyncJobData.cs +++ b/Tizen.Account.SyncManager/Tizen.Account.SyncManager/SyncJobData.cs @@ -20,70 +20,70 @@ using Tizen.Account.AccountManager; namespace Tizen.Account.SyncManager { /// <summary> - /// Class represents information about a sync job request + /// This class represents information about the sync job request. /// </summary> public class SyncJobData { /// <summary> - /// Represents calendar capability + /// Represents the calendar capability. /// </summary> /// <remarks> - /// If you want to receive notification about calendar database change, assign it to SyncJobName property of SyncJobData object. + /// If you want to receive notification about the calendar database change, assign it to the SyncJobName property of the SyncJobData object. /// </remarks> public const string CalendarCapability = "http://tizen.org/sync/capability/calendar"; /// <summary> - /// Represents contact capability + /// Represents the contact capability. /// </summary> /// <remarks> - /// If you want to receive notification about contact database change, assign it to SyncJobName property of SyncJobData object. + /// If you want to receive notification about the contact database change, assign it to the SyncJobName property of the SyncJobData object. /// </remarks> public const string ContactCapability = "http://tizen.org/sync/capability/contact"; /// <summary> - /// Represents image capability + /// Represents the image capability. /// </summary> /// <remarks> - /// If you want to receive notification about image database change, assign it to SyncJobName property of SyncJobData object. + /// If you want to receive notification about the image database change, assign it to the SyncJobName property of the SyncJobData object. /// </remarks> public const string ImageCapability = "http://tizen.org/sync/capability/image"; /// <summary> - /// Represents video capability + /// Represents the video capability. /// </summary> /// <remarks> - /// If you want to receive notification about video database change, assign it to SyncJobName property of SyncJobData object. + /// If you want to receive notification about the video database change, assign it to the SyncJobName property of the SyncJobData object. /// </remarks> public const string VideoCapability = "http://tizen.org/sync/capability/video"; /// <summary> - /// Represents sound capability + /// Represents the sound capability. /// </summary> /// <remarks> - /// If you want to receive notification about sound database change, assign it to SyncJobName property of SyncJobData object. + /// If you want to receive notification about the sound database change, assign it to the SyncJobName property of the SyncJobData object. /// </remarks> public const string SoundCapability = "http://tizen.org/sync/capability/sound"; /// <summary> - /// Represents music capability + /// Represents the music capability. /// </summary> /// <remarks> - /// If you want to receive notification about music database change, assign it to SyncJobName property of SyncJobData object. + /// If you want to receive notification about the music database change, assign it to the SyncJobName property of the SyncJobData object. /// </remarks> public const string MusicCapability = "http://tizen.org/sync/capability/music"; /// <summary> - /// The account instance on which sync operation was requested or @c null in the case of accountless sync operation + /// The account instance on which the sync operation was requested or @c null in the case of the accountless sync operation. /// </summary> public AccountManager.Account Account { get; set; } /// <summary> - /// User data which contains additional information related registered sync job + /// User data which contains an additional information related to the registered sync job. /// </summary> public Bundle UserData { get; set; } /// <summary> - /// A string representing a sync job which has been operated or capability setting to operate data change sync job + /// A string representing a sync job which has been operated or capability setting to operate the data change sync job. /// </summary> public string SyncJobName { get; set; } } |