aboutsummaryrefslogtreecommitdiffstats
path: root/Software/Visual_Studio
diff options
context:
space:
mode:
authorRoy Ben-Shabat <Roy@Twine-s.com>2018-01-08 15:33:28 +0200
committerRoy Ben-Shabat <Roy@Twine-s.com>2018-01-08 15:33:28 +0200
commit6bac62d0d08cb87e8925f05a6371c76fc52af009 (patch)
treec6d78574242a1cc3c309cd210f7f4692e00680e8 /Software/Visual_Studio
parentd1e8b5dc2cfa93bf042773b4bf04a0f0bfc1f53d (diff)
downloadTango-6bac62d0d08cb87e8925f05a6371c76fc52af009.tar.gz
Tango-6bac62d0d08cb87e8925f05a6371c76fc52af009.zip
Added code comments for:
DAL.Local. DAL.Remote. DragAndDrop.
Diffstat (limited to 'Software/Visual_Studio')
-rw-r--r--Software/Visual_Studio/Tango.DAL.Local/Partials/LocalDB.cs13
-rw-r--r--Software/Visual_Studio/Tango.DAL.Remote/Partials/RemoteDB.cs19
-rw-r--r--Software/Visual_Studio/Tango.DragAndDrop/DragAndDropService.cs13
3 files changed, 32 insertions, 13 deletions
diff --git a/Software/Visual_Studio/Tango.DAL.Local/Partials/LocalDB.cs b/Software/Visual_Studio/Tango.DAL.Local/Partials/LocalDB.cs
index 2ad765a2b..db66f1c0a 100644
--- a/Software/Visual_Studio/Tango.DAL.Local/Partials/LocalDB.cs
+++ b/Software/Visual_Studio/Tango.DAL.Local/Partials/LocalDB.cs
@@ -7,13 +7,26 @@ using System.Threading.Tasks;
namespace Tango.DAL.Local.DB
{
+ /// <summary>
+ /// Represents an SQLite database context.
+ /// </summary>
+ /// <seealso cref="System.Data.Entity.DbContext" />
public partial class LocalDB : DbContext
{
+ /// <summary>
+ /// Initializes a new instance of the <see cref="LocalDB"/> class.
+ /// </summary>
+ /// <param name="filePath">The file path.</param>
public LocalDB(String filePath) : base(ComposeConnectionString(filePath))
{
}
+ /// <summary>
+ /// Composes the connection string.
+ /// </summary>
+ /// <param name="filePath">The file path.</param>
+ /// <returns></returns>
private static String ComposeConnectionString(String filePath)
{
return String.Format("metadata=res://*/DB.LocalADO.csdl|res://*/DB.LocalADO.ssdl|res://*/DB.LocalADO.msl;provider=System.Data.SQLite.EF6;provider connection string=\"data source={0}\"", filePath);
diff --git a/Software/Visual_Studio/Tango.DAL.Remote/Partials/RemoteDB.cs b/Software/Visual_Studio/Tango.DAL.Remote/Partials/RemoteDB.cs
index f6fcbcf3f..96ddf9550 100644
--- a/Software/Visual_Studio/Tango.DAL.Remote/Partials/RemoteDB.cs
+++ b/Software/Visual_Studio/Tango.DAL.Remote/Partials/RemoteDB.cs
@@ -8,13 +8,28 @@ using Tango.Settings;
namespace Tango.DAL.Remote.DB
{
+ /// <summary>
+ /// Represents an SQL Server database context.
+ /// </summary>
+ /// <seealso cref="System.Data.Entity.DbContext" />
public partial class RemoteDB : DbContext
{
+ /// <summary>
+ /// Initializes a new instance of the <see cref="RemoteDB"/> class.
+ /// </summary>
+ /// <param name="path">The server file path.</param>
+ /// <param name="isFile">if set to <c>true</c> will try to connect to an .mdf file.</param>
public RemoteDB(String path, bool isFile) : base(ComposeConnectionString(path, isFile))
{
}
+ /// <summary>
+ /// Composes the connection string.
+ /// </summary>
+ /// <param name="source">The source.</param>
+ /// <param name="isFile">if set to <c>true</c> [is file].</param>
+ /// <returns></returns>
private static String ComposeConnectionString(String source, bool isFile)
{
if (!isFile)
@@ -27,6 +42,10 @@ namespace Tango.DAL.Remote.DB
}
}
+ /// <summary>
+ /// Creates a default remote database context by the address specified in <see cref="SettingsManager.Default.DataBase.SQLServerAddress"/>.
+ /// </summary>
+ /// <returns></returns>
public static RemoteDB CreateDefault()
{
return new RemoteDB(SettingsManager.Default.DataBase.SQLServerAddress, false);
diff --git a/Software/Visual_Studio/Tango.DragAndDrop/DragAndDropService.cs b/Software/Visual_Studio/Tango.DragAndDrop/DragAndDropService.cs
index fe58367aa..606e8a2e5 100644
--- a/Software/Visual_Studio/Tango.DragAndDrop/DragAndDropService.cs
+++ b/Software/Visual_Studio/Tango.DragAndDrop/DragAndDropService.cs
@@ -16,21 +16,8 @@ using Tango.SharedUI.Helpers;
namespace Tango.DragAndDrop
{
/// <summary>
- /// <para><img class="classImage" src="../Media/DragAndDropService.png" /></para>
/// Represents a drag and drop service which exposes several attached properties and events to create an interactive drag and drop functionality.
/// </summary>
- /// <example>
- /// <para class="example-title">
- /// <img class="exampleIcon" src="../Icons/CodeExample.png" />
- /// <i>
- /// The following example demonstrates how to use the Drag and Drop service and the <see cref="DraggingSurface"/> to easily create drag and drop features.
- /// </i>
- /// </para>
- /// <para>
- /// <markup><video class="exampleVideo" autoplay="autoplay" controls="controls" loop="loop" src="../Media/DragAndDropExample.mp4"></video></markup>
- /// </para>
- /// <code lang="XAML" source="../FullAPIExamples/Examples/DragAndDrop/DragAndDropExample.xaml" title="Drag and Drop Example." />
- /// </example>
/// <seealso cref="DraggingSurface" />
/// <seealso cref="DropEventArgs" />
public static class DragAndDropService