aboutsummaryrefslogtreecommitdiffstats
path: root/Software/Visual_Studio/Tango.Synchronization/Remote/RemoteDBSynchronizer.cs
diff options
context:
space:
mode:
authorRoy Ben-Shabat <Roy@Twine-s.com>2018-01-14 13:19:03 +0200
committerRoy Ben-Shabat <Roy@Twine-s.com>2018-01-14 13:19:03 +0200
commitd1fa1f1a2e26469a6bbb5b82ab614079beffcb52 (patch)
tree5823e82075a6bd9c932457f79a6269395d45fe23 /Software/Visual_Studio/Tango.Synchronization/Remote/RemoteDBSynchronizer.cs
parentdd4560b79e305772debf48cc76c9ba67af61f259 (diff)
downloadTango-d1fa1f1a2e26469a6bbb5b82ab614079beffcb52.tar.gz
Tango-d1fa1f1a2e26469a6bbb5b82ab614079beffcb52.zip
Added code comments for:
Synchronization.
Diffstat (limited to 'Software/Visual_Studio/Tango.Synchronization/Remote/RemoteDBSynchronizer.cs')
-rw-r--r--Software/Visual_Studio/Tango.Synchronization/Remote/RemoteDBSynchronizer.cs17
1 files changed, 17 insertions, 0 deletions
diff --git a/Software/Visual_Studio/Tango.Synchronization/Remote/RemoteDBSynchronizer.cs b/Software/Visual_Studio/Tango.Synchronization/Remote/RemoteDBSynchronizer.cs
index 7abd8ad7e..75d28af5b 100644
--- a/Software/Visual_Studio/Tango.Synchronization/Remote/RemoteDBSynchronizer.cs
+++ b/Software/Visual_Studio/Tango.Synchronization/Remote/RemoteDBSynchronizer.cs
@@ -10,8 +10,18 @@ using Tango.Synchronization.Local;
namespace Tango.Synchronization.Remote
{
+ /// <summary>
+ /// Represents a remote database to SQLite file synchronizer.
+ /// </summary>
public class RemoteDBSynchronizer
{
+ /// <summary>
+ /// Synchronizes the specified SQLite file by a machine serial number.
+ /// </summary>
+ /// <param name="sqliteDbFile">The SQLite database file.</param>
+ /// <param name="serialNumber">The machine serial number.</param>
+ /// <param name="overrideLocal">if set to <c>true</c> will erase the SQLite file before performing the synchronization.</param>
+ /// <returns></returns>
public static List<Diff> Synchronize(String sqliteDbFile, String serialNumber, bool overrideLocal = false)
{
if (overrideLocal)
@@ -41,6 +51,13 @@ namespace Tango.Synchronization.Remote
}
}
+ /// <summary>
+ /// Synchronizes the specified SQLite file by a machine serial number.
+ /// </summary>
+ /// <param name="sqliteDbFile">The SQLite database file.</param>
+ /// <param name="serialNumber">The machine serial number.</param>
+ /// <param name="overrideLocal">if set to <c>true</c> will erase the SQLite file before performing the synchronization.</param>
+ /// <returns></returns>
public static Task<List<Diff>> SynchronizeAsync(String sqliteDBFile, String serialNumber, bool overrideLocal = false)
{
return Task.Factory.StartNew<List<Diff>>(() =>