Added some xml docs, changed links in nuspec files

RicoSuter · Jun 16, 2015 · 16b32aa · 16b32aa
1 parent d3c4006
commit 16b32aa
Show file tree

Hide file tree

Showing 9 changed files with 34 additions and 14 deletions.
diff --git a/build/MyToolkit.AspNet.Mvc.nuspec b/build/MyToolkit.AspNet.Mvc.nuspec
@@ -6,8 +6,8 @@
     <title>MyToolkit.AspNet.Mvc</title>
     <authors>Rico Suter</authors>
     <owners>Rico Suter</owners>
-    <projectUrl>https://github.com/MyToolkit/Core</projectUrl>
-    <licenseUrl>https://github.com/MyToolkit/Core/blob/master/LICENSE.md</licenseUrl>
+    <projectUrl>https://github.com/MyToolkit/MyToolkit</projectUrl>
+    <licenseUrl>https://github.com/MyToolkit/MyToolkit/blob/master/LICENSE.md</licenseUrl>
     <description>MyToolkit is a set of .NET libraries containing lots of useful classes for various .NET platforms like WinRT, Windows Phone, WPF and Silverlight. </description>
     <releaseNotes/>
     <iconUrl>http://rsuter.com/Projects/MyToolkit/NuGetIcon.png</iconUrl>

diff --git a/build/MyToolkit.Extended.nuspec b/build/MyToolkit.Extended.nuspec
@@ -6,8 +6,8 @@
     <title>MyToolkit.Extended</title>
     <authors>Rico Suter</authors>
     <owners>Rico Suter</owners>
-    <projectUrl>https://github.com/MyToolkit/Core</projectUrl>
-    <licenseUrl>https://github.com/MyToolkit/Core/blob/master/LICENSE.md</licenseUrl>
+    <projectUrl>https://github.com/MyToolkit/MyToolkit</projectUrl>
+    <licenseUrl>https://github.com/MyToolkit/MyToolkit/blob/master/LICENSE.md</licenseUrl>
     <description>MyToolkit is a set of .NET libraries containing lots of useful classes for various .NET platforms like WinRT, Windows Phone, WPF and Silverlight. </description>
     <releaseNotes/>
     <iconUrl>http://rsuter.com/Projects/MyToolkit/IconNuGet.png</iconUrl>

diff --git a/build/MyToolkit.Http.nuspec b/build/MyToolkit.Http.nuspec
@@ -6,8 +6,8 @@
     <title>MyToolkit.Http</title>
     <authors>Rico Suter</authors>
     <owners>Rico Suter</owners>
-    <projectUrl>https://github.com/MyToolkit/Core</projectUrl>
-    <licenseUrl>https://github.com/MyToolkit/Core/blob/master/LICENSE.md</licenseUrl>
+    <projectUrl>https://github.com/MyToolkit/MyToolkit</projectUrl>
+    <licenseUrl>https://github.com/MyToolkit/MyToolkit/blob/master/LICENSE.md</licenseUrl>
     <description>MyToolkit is a set of .NET libraries containing lots of useful classes for various .NET platforms like WinRT, Windows Phone, WPF and Silverlight. </description>
     <releaseNotes/>
     <iconUrl>http://rsuter.com/Projects/MyToolkit/NuGetIcon.png</iconUrl>

diff --git a/build/MyToolkit.Web.nuspec b/build/MyToolkit.Web.nuspec
@@ -6,8 +6,8 @@
     <title>MyToolkit.Web</title>
     <authors>Rico Suter</authors>
     <owners>Rico Suter</owners>
-    <projectUrl>https://github.com/MyToolkit/Core</projectUrl>
-    <licenseUrl>https://github.com/MyToolkit/Core/blob/master/LICENSE.md</licenseUrl>
+    <projectUrl>https://github.com/MyToolkit/MyToolkit</projectUrl>
+    <licenseUrl>https://github.com/MyToolkit/MyToolkit/blob/master/LICENSE.md</licenseUrl>
     <description>MyToolkit is a set of .NET libraries containing lots of useful classes for various .NET platforms like WinRT, Windows Phone, WPF and Silverlight. </description>
     <releaseNotes/>
     <iconUrl>http://rsuter.com/Projects/MyToolkit/NuGetIcon.png</iconUrl>

diff --git a/build/MyToolkit.nuspec b/build/MyToolkit.nuspec
@@ -6,8 +6,8 @@
     <title>MyToolkit</title>
     <authors>Rico Suter</authors>
     <owners>Rico Suter</owners>
-    <projectUrl>https://github.com/MyToolkit/Core</projectUrl>
-    <licenseUrl>https://github.com/MyToolkit/Core/blob/master/LICENSE.md</licenseUrl>
+    <projectUrl>https://github.com/MyToolkit/MyToolkit</projectUrl>
+    <licenseUrl>https://github.com/MyToolkit/MyToolkit/blob/master/LICENSE.md</licenseUrl>
     <description>MyToolkit is a set of .NET libraries containing lots of useful classes for various .NET platforms like WinRT, Windows Phone, WPF and Silverlight. </description>
     <releaseNotes/>
     <iconUrl>http://rsuter.com/Projects/MyToolkit/NuGetIcon.png</iconUrl>

diff --git a/src/MyToolkit/Messaging/LoadingMessage.cs b/src/MyToolkit/Messaging/LoadingMessage.cs
@@ -8,13 +8,17 @@
 
 namespace MyToolkit.Messaging
 {
+    /// <summary>A message to show or hide a loading progress.</summary>
 	public class LoadingMessage
 	{
+        /// <summary>Initializes a new instance of the <see cref="LoadingMessage"/> class.</summary>
+        /// <param name="isLoading">Value indicating whether to show the loading progress.</param>
 		public LoadingMessage(bool isLoading)
 		{
 			IsLoading = isLoading; 
 		}
 
+        /// <summary>Gets or sets a value indicating whether to show the loading progress.</summary>
 		public bool IsLoading { get; set; }
 	}
 }
diff --git a/src/MyToolkit/Messaging/TextMessage.cs b/src/MyToolkit/Messaging/TextMessage.cs
@@ -43,19 +43,35 @@ public TextMessage(string text, string title, MessageButton button)
         public MessageButton Button { get; private set; }
 	}
 
+    /// <summary>Enumeration of the buttons to show of a text message.</summary>
     public enum MessageButton
     {
+        /// <summary>Shows only an OK button.</summary>
         OK,
+
+        /// <summary>Shows an OK and Cancel button.</summary>
         OKCancel,
+
+        /// <summary>Shows an Yes, No and Cancel button.</summary>
         YesNoCancel,
+
+        /// <summary>Shows an Yes and No button.</summary>
         YesNo
     }
 
+    /// <summary>Enumeration of the results of a text message.</summary>
     public enum MessageResult
     {
-        OK,
+        /// <summary>The OK button was pressed.</summary>
+        Ok,
+
+        /// <summary>The Cancel button was pressed.</summary>
         Cancel,
+
+        /// <summary>The Yes button was pressed.</summary>
         Yes,
+
+        /// <summary>The No button was pressed.</summary>
         No
     }
 }
diff --git a/src/SamplePhoneApp/Views/DetailsPage.xaml.cs b/src/SamplePhoneApp/Views/DetailsPage.xaml.cs
@@ -40,7 +40,7 @@ protected void BackKeyPressHandler(CancelEventArgs e)
                 var msg = new TextMessage("Not valid", "Discard?", MessageButton.OKCancel); // TODO use strings from resource file
                 msg.SuccessCallback += result =>
 			    {
-			        if (result == MessageResult.OK)
+			        if (result == MessageResult.Ok)
 			        {
 			            App.Persons.Remove(Model.Person);
 			            NavigationService.GoBack();

diff --git a/src/Shared/Messaging/DefaultActions.cs b/src/Shared/Messaging/DefaultActions.cs
@@ -93,7 +93,7 @@ private static async Task GetTextMessageImplementation(TextMessage message)
 
                 var index = msg.Commands.IndexOf(cmd); 
                 if (message.Button == MessageButton.OKCancel)
-                    message.CallSuccessCallback(index == 0 ? MessageResult.OK : MessageResult.Cancel);
+                    message.CallSuccessCallback(index == 0 ? MessageResult.Ok : MessageResult.Cancel);
                 else if (message.Button == MessageButton.YesNoCancel)
                     message.CallSuccessCallback(index == 0 ? MessageResult.Yes : 
                         (index == 1 ? MessageResult.No : MessageResult.Cancel));
@@ -128,7 +128,7 @@ public static Action<TextMessage> GetTextMessageAction()
                 else if (result == MessageBoxResult.No)
                     message.CallSuccessCallback(MessageResult.No);
                 else if (result == MessageBoxResult.OK)
-                    message.CallSuccessCallback(MessageResult.OK);
+                    message.CallSuccessCallback(MessageResult.Ok);
                 else if (result == MessageBoxResult.Cancel)
                     message.CallSuccessCallback(MessageResult.Cancel);
             };