Style 👮 plus sanitation.

Author: JimBobSquarePants

src/UmbracoFileSystemProviders.Azure.Installer/Configurator/Controllers/Configure.js

@@ -1,4 +1,4 @@
-var configApp = angular.module('UFSPLoader', []);
+var configApp = angular.module("UFSPLoader", []);
 
 configApp.controller("Loader", function ($scope, $http, $log) {
     var getDataUrl = "/Umbraco/backoffice/FileSystemProviders/Installer/GetParameters";
@@ -14,30 +14,30 @@ configApp.controller("Loader", function ($scope, $http, $log) {
     $scope.submitForm = function (e) {
         e.preventDefault();
 
-        $http.post(postDataUrl, $scope.parameters).success(function (data) {
+        $http.post(postDataUrl, $scope.parameters)
+            .success(function (data) {
 
-            var status;
-            if (typeof data === "string") {
-                status = JSON.parse(data);
-            } else {
-                status = data;
-            }
+                var status;
+                if (typeof data === "string") {
+                    status = JSON.parse(data);
+                } else {
+                    status = data;
+                }
 
-            $scope.status = status;
+                $scope.status = status;
 
-            if (status !== "ConnectionError") {
-                $scope.saved = true;
-            }
+                if (status !== "ConnectionError") {
+                    $scope.saved = true;
+                }
 
-        });
-
-    }
+            });
+    };
 
     $scope.capitalizeFirstLetter = function (string) {
         return string.charAt(0).toUpperCase() + string.slice(1);
-    }
+    };
 
     $scope.getInputType = function (param) {
         return param.toUpperCase() === "USEDEFAULTROUTE" ? "checkbox" : "text";
-    }
+    };
 });

src/UmbracoFileSystemProviders.Azure.Installer/Constants.cs

@@ -1,31 +1,74 @@
-// --------------------------------------------------------------------------------------------------------------------
-// <copyright file="Constants.cs" company="James Jackson-South">
-// Copyright (c) James Jackson-South. All rights reserved.
+// <copyright file="Constants.cs" company="James Jackson-South, Jeavon Leopold, and contributors">
+// Copyright (c) James Jackson-South, Jeavon Leopold, and contributors. All rights reserved.
 // Licensed under the Apache License, Version 2.0.
 // </copyright>
-// <summary>
-//   Constant strings for use within the application.
-// </summary>
-// --------------------------------------------------------------------------------------------------------------------
+
 namespace Our.Umbraco.FileSystemProviders.Azure.Installer
 {
+    /// <summary>
+    /// Contains constants related to the installer.
+    /// </summary>
     public static class Constants
     {
+        /// <summary>
+        /// The installer path for the plugin.
+        /// </summary>
         public const string InstallerPath = "~/App_Plugins/UmbracoFileSystemProviders/Azure/Install/";
+
+        /// <summary>
+        /// The filesystem provider configuration file name.
+        /// </summary>
         public const string FileSystemProvidersConfigFile = "FileSystemProviders.config";
+
+        /// <summary>
+        /// The Umbraco configuration path.
+        /// </summary>
         public const string UmbracoConfigPath = "~/Config/";
+
+        /// <summary>
+        /// The web configuration file name.
+        /// </summary>
         public const string WebConfigFile = "web.config";
+
+        /// <summary>
+        /// The full qualified type name for the provider.
+        /// </summary>
         public const string ProviderType = "Our.Umbraco.FileSystemProviders.Azure.AzureBlobFileSystem, Our.Umbraco.FileSystemProviders.Azure";
 
+        /// <summary>
+        /// Contains constant values related to the ImageProcessor library.
+        /// </summary>
         public class ImageProcessor
         {
+            /// <summary>
+            /// The assembly path to the ImageProcessor.Web binary.
+            /// </summary>
             public const string WebAssemblyPath = "~/bin/ImageProcessor.Web.dll";
+
+            /// <summary>
+            /// The minimum ImageProcessor.Web version.
+            /// </summary>
             public const string WebMinRequiredVersion = "4.3.2.0";
+
+            /// <summary>
+            /// The ImageProcessor.Web configuration path.
+            /// </summary>
             public const string ConfigPath = "~/Config/imageprocessor/";
+
+            /// <summary>
+            /// The ImageProcessor.Web security configuration file.
+            /// </summary>
             public const string SecurityConfigFile = "security.config";
+
+            /// <summary>
+            /// The full qualified type for the ImageProcessor.Web CloudImageService.
+            /// </summary>
             public const string SecurityServiceType = "ImageProcessor.Web.Services.CloudImageService, ImageProcessor.Web";
-            public const string SecurityServiceName = "CloudImageService";
 
+            /// <summary>
+            /// The CloudImageService name.
+            /// </summary>
+            public const string SecurityServiceName = "CloudImageService";
         }
     }
 }

src/UmbracoFileSystemProviders.Azure.Installer/Enums/InstallerStatus.cs

@@ -1,22 +1,47 @@
-// --------------------------------------------------------------------------------------------------------------------
-// <copyright file="InstallerStatus.cs" company="James Jackson-South">
-// Copyright (c) James Jackson-South. All rights reserved. Licensed under the Apache License, Version 2.0.
+// <copyright file="InstallerStatus.cs" company="James Jackson-South, Jeavon Leopold, and contributors">
+// Copyright (c) James Jackson-South, Jeavon Leopold, and contributors. All rights reserved.
+// Licensed under the Apache License, Version 2.0.
 // </copyright>
-// --------------------------------------------------------------------------------------------------------------------
 
 namespace Our.Umbraco.FileSystemProviders.Azure.Installer.Enums
 {
     using Newtonsoft.Json;
     using Newtonsoft.Json.Converters;
 
+    /// <summary>
+    /// Provides enumeration of the installer status codes.
+    /// </summary>
     [JsonConverter(typeof(StringEnumConverter))]
     public enum InstallerStatus
     {
+        /// <summary>
+        /// The install has completed sucessfully.
+        /// </summary>
         Ok,
+
+        /// <summary>
+        /// Unable to save to the XDT file.
+        /// </summary>
         SaveXdtError,
+
+        /// <summary>
+        /// Unable to save the configuration value.
+        /// </summary>
         SaveConfigError,
+
+        /// <summary>
+        /// Unable to connect to the blob storage account.
+        /// </summary>
         ConnectionError,
+
+        /// <summary>
+        /// Incompatible ImageProcessor.Web version.
+        /// </summary>
         ImageProcessorWebCompatibility,
+
+        /// <summary>
+        /// Unable to save the ImageProcessor.Web configuration value.
+        /// </summary>
         ImageProcessorWebConfigError
     }
 }