Merge pull request #137 from southworkscom/fix/stylecop/botkit/botwor…

…ker-issues [StyleCop] Fix remaining warnings in BotWorker, DialogData, DialogElement and CMSConfiguration class
microsoft · Jun 24, 2019 · 26fd5f3 · 26fd5f3
2 parents c0b043e + e41305b
commit 26fd5f3
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 6 deletions.
diff --git a/libraries/Microsoft.BotKit.Adapters.Slack/DialogData.cs b/libraries/Microsoft.BotKit.Adapters.Slack/DialogData.cs
@@ -1,4 +1,4 @@
-// Copyright(c) Microsoft Corporation.All rights reserved.
+// Copyright(c) Microsoft Corporation.All rights reserved.
 // Licensed under the MIT License.
 
 using System.Collections.Generic;
@@ -28,31 +28,37 @@ public DialogData(string title, string callback, string submit, List<DialogEleme
         /// <summary>
         /// Gets or Sets the tittle of the dialog.
         /// </summary>
+        /// <value>The tittle of the dialog.</value>
         public string Title { get; set; }
 
         /// <summary>
         /// Gets or Sets the callback Id of the dialog.
         /// </summary>
+        /// <value>The callback id of the dialog.</value>
         public string CallbackId { get; set; }
 
         /// <summary>
         /// Gets or Sets the submit label of the dialog.
         /// </summary>
+        /// <value>The submit label of the dialog.</value>
         public string SubmitLabel { get; set; }
 
         /// <summary>
         /// Gets or Sets a list of elements contained by the dialog.
         /// </summary>
+        /// <value>The elements of the dialog.</value>
         public List<DialogElement> Elements { get; set; }
 
         /// <summary>
         /// Gets or Sets the state of the dialog.
         /// </summary>
+        /// <value>The state of the dialog.</value>
         public string State { get; set; }
 
         /// <summary>
         /// Gets or sets a value indicating whether the dialog should notify on cancel or not.
         /// </summary>
+        /// <value>The notifyOnCancel indicator of the dialog.</value>
         public bool NotifyOnCancel { get; set; }
     }
-}
+}
diff --git a/libraries/Microsoft.BotKit.Adapters.Slack/DialogElement.cs b/libraries/Microsoft.BotKit.Adapters.Slack/DialogElement.cs
@@ -1,4 +1,4 @@
-// Copyright(c) Microsoft Corporation.All rights reserved.
+// Copyright(c) Microsoft Corporation.All rights reserved.
 // Licensed under the MIT License.
 
 using System.Collections.Generic;
@@ -13,36 +13,43 @@ public class DialogElement
         /// <summary>
         /// Gets or Sets the label for the dialog element.
         /// </summary>
+        /// <value>The label for the element.</value>
         public string Label { get; set; }
 
         /// <summary>
         /// Gets or Sets the name for the dialog element.
         /// </summary>
+        /// <value>The name for the element.</value>
         public string Name { get; set; }
 
         /// <summary>
         /// Gets or Sets the value for the dialog element.
         /// </summary>
+        /// <value>The value for the element.</value>
         public string Value { get; set; }
 
         /// <summary>
         /// Gets or Sets the pair of values for an option List in the dialog element.
         /// </summary>
+        /// <value>The option list for the element.</value>
         public Dictionary<string, string> OptionList { get; set; }
 
         /// <summary>
         /// Gets or Sets options for the dialog element.
         /// </summary>
+        /// <value>The options for the element.</value>
         public ISlackAdapterOptions Options { get; set; }
 
         /// <summary>
         /// Gets or Sets the type for the dialog element.
         /// </summary>
+        /// <value>The type for the element.</value>
         public string Type { get; set; }
 
         /// <summary>
         /// Gets or Sets the subtype for the dialog element.
         /// </summary>
+        /// <value>The subtype for the element.</value>
         public string Subtype { get; set; }
     }
 }
diff --git a/libraries/Microsoft.BotKit/BotWorker.cs b/libraries/Microsoft.BotKit/BotWorker.cs
@@ -19,8 +19,6 @@ namespace Microsoft.BotKit
     /// </summary>
     public class BotWorker
     {
-        public BotWorkerConfiguration Config { get; private set; }
-
         /// <summary>
         /// Initializes a new instance of the <see cref="BotWorker"/> class.
         /// Create a new BotWorker instance. Do not call this directly - instead, use controller.spawn().
@@ -33,9 +31,16 @@ public BotWorker(Botkit controller, BotWorkerConfiguration config)
             this.Config = config;
         }
 
+        /// <summary>
+        /// Gets the configuration for BotWorker.
+        /// </summary>
+        /// <value>The BotWorker Configuration.</value>
+        public BotWorkerConfiguration Config { get; private set; }
+
         /// <summary>
         /// Gets Controller of BotWorker.
         /// </summary>
+        /// <value>The BotWorker Controller.</value>
         public Botkit Controller { get; }
 
         /// <summary>

diff --git a/libraries/Microsoft.BotKit/CMS/CMSConfiguration.cs b/libraries/Microsoft.BotKit/CMS/CMSConfiguration.cs
@@ -1,4 +1,4 @@
-// Copyright(c) Microsoft Corporation.All rights reserved.
+// Copyright(c) Microsoft Corporation.All rights reserved.
 // Licensed under the MIT License.
 
 namespace Microsoft.BotKit.CMS