Added missing XML documentation

skybrud · Jul 13, 2019 · 6cf985b · 6cf985b
1 parent 3ee6adf
commit 6cf985b
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/src/Skybrud.Umbraco.GridData/Attributes/GridViewAttribute.cs b/src/Skybrud.Umbraco.GridData/Attributes/GridViewAttribute.cs
@@ -2,11 +2,21 @@
 
 namespace Skybrud.Umbraco.GridData.Attributes {
 
+    /// <summary>
+    /// Attribute used for specifying the suggested view path for a grid control value.
+    /// </summary>
     [AttributeUsage(AttributeTargets.Class)]
     public class GridViewAttribute : Attribute {
 
+        /// <summary>
+        /// Gets the suggested view path.
+        /// </summary>
         public string ViewPath { get; }
 
+        /// <summary>
+        /// Initializes a new instance based on the specified <paramref name="viewPath"/>.
+        /// </summary>
+        /// <param name="viewPath">The suggested view path.</param>
         public GridViewAttribute(string viewPath) {
             if (string.IsNullOrWhiteSpace(viewPath)) throw new ArgumentNullException(nameof(viewPath));
             ViewPath = viewPath;

diff --git a/src/Skybrud.Umbraco.GridData/GridDataModel.cs b/src/Skybrud.Umbraco.GridData/GridDataModel.cs
@@ -204,6 +204,12 @@ public static GridDataModel Deserialize(string json, string propertyTypeAlias) {
 
         }
 
+        /// <summary>
+        /// Deserializes the specified <paramref name="json"/> string into an instance of <see cref="GridDataModel"/>.
+        /// </summary>
+        /// <param name="json">The JSON string to be deserialized.</param>
+        /// <param name="propertyTypeAlias">The alias of the property the Grid model is representing.</param>
+        /// <param name="config">The Grid configuration to be used.</param>
         public static GridDataModel Deserialize(string json, string propertyTypeAlias, IGridConfig config) {
 
             // Validate the JSON