Headings and doc updates (#157)

* move around comments

* add headers to everything

* fix parameters

* update docs

Author: TylerLeonhardt

PSScriptAnalyzerSettings.psd1

@@ -1,3 +1,8 @@
+#
+# Copyright (c) Microsoft. All rights reserved.
+# Licensed under the MIT license. See LICENSE file in the project root for full license information.
+#
+
 @{
     Rules = @{
         PSAvoidUsingCmdletAliases = @{

Polaris.psm1

@@ -1,4 +1,9 @@
-$Script:Polaris = $null
+#
+# Copyright (c) Microsoft. All rights reserved.
+# Licensed under the MIT license. See LICENSE file in the project root for full license information.
+#
+
+$Script:Polaris = $null
 
 # Handles the removal of the module
 $ExecutionContext.SessionState.Module.OnRemove =

Private/Create-NewPolarisIfNeeded.ps1

@@ -1,3 +1,8 @@
+#
+# Copyright (c) Microsoft. All rights reserved.
+# Licensed under the MIT license. See LICENSE file in the project root for full license information.
+#
+
 function CreateNewPolarisIfNeeded () {
     if ( -not $Script:Polaris ) {
         $Script:Polaris = [Polaris]::New(

Public/Clear-Polaris.ps1

@@ -1,12 +1,17 @@
+#
+# Copyright (c) Microsoft. All rights reserved.
+# Licensed under the MIT license. See LICENSE file in the project root for full license information.
+#
+
 <#
 .SYNOPSIS
-Clears the internal instance of Polaris
+    Clears the internal instance of Polaris
 .DESCRIPTION
-Clears the internal Polaris .NET Standard object.  The instance will be reinstantiated in other module calls.
+    Clears the internal Polaris .NET Standard object.  The instance will be reinstantiated in other module calls.
 .EXAMPLE
-Clear-Polaris
+    Clear-Polaris
 .NOTES
-Should only be used for testing
+    Should only be used for testing
 #>
 function Clear-Polaris {
     if ($Script:Polaris) {

Public/Get-Polaris.ps1

@@ -1,14 +1,18 @@
+#
+# Copyright (c) Microsoft. All rights reserved.
+# Licensed under the MIT license. See LICENSE file in the project root for full license information.
+#
+
 <#
 .SYNOPSIS
-Returns the internal instance of Polaris
+    Returns the internal instance of Polaris
 .DESCRIPTION
-Returns the instance of the Polaris .NET Standard object
+    Returns the instance of the Polaris .NET Standard object
 .EXAMPLE
-Get-Polaris
+    Get-Polaris
 .NOTES
-Should only be used for testing
+    Should only be used for testing
 #>
 function Get-Polaris {
     return $Script:Polaris
 }
-

Public/Get-PolarisRoute.ps1

@@ -1,3 +1,8 @@
+#
+# Copyright (c) Microsoft. All rights reserved.
+# Licensed under the MIT license. See LICENSE file in the project root for full license information.
+#
+
 <#
 .SYNOPSIS
     Get web routes.

Public/Get-PolarisRouteMiddleware.ps1

@@ -1,3 +1,8 @@
+#
+# Copyright (c) Microsoft. All rights reserved.
+# Licensed under the MIT license. See LICENSE file in the project root for full license information.
+#
+
 <#
 .SYNOPSIS
     Get route middleware.

Public/New-DirectoryBrowser.ps1

@@ -1,19 +1,26 @@
-function New-DirectoryBrowser {
+#
+# Copyright (c) Microsoft. All rights reserved.
+# Licensed under the MIT license. See LICENSE file in the project root for full license information.
+#
 
-    <#
-    .SYNOPSIS
-        Renders a directory browser in HTML
-    .DESCRIPTION
-        Creates HTML that can be used as a directory browser
-    .PARAMETER RequestedItem
-        The directory you would like to generate HTML for
-    .PARAMETER HeaderName
-        The name you would like displayed at the top of the directory browser
-    .PARAMETER DirectoryBrowserPath
-        The current path in the directory browser relative to the root of the directory
-        browser (not the root of the site).
+<#
+.SYNOPSIS
+    Renders a directory browser in HTML
+.DESCRIPTION
+    Creates HTML that can be used as a directory browser
+.PARAMETER RequestedItem
+    The directory you would like to generate HTML for
+.PARAMETER HeaderName
+    The name you would like displayed at the top of the directory browser
+.PARAMETER DirectoryBrowserPath
+    The current path in the directory browser relative to the root of the directory
+    browser (not the root of the site).
+.EXAMPLE
+    New-DirectoryBrowser -RequestedItem $directoryInfo
+.EXAMPLE
+    New-DirectoryBrowser -RequestedItem $directoryInfo -DirectoryBrowserPath ./MyContent
 #>
-
+function New-DirectoryBrowser {
     param (
 
         [Parameter(
@@ -63,4 +70,4 @@ $(if ($RequestedItem.FullName.TrimEnd([System.IO.Path]::DirectorySeparatorChar)
 </body>
 </html>
 "@
-}
+}

Public/New-PolarisDeleteRoute.ps1

@@ -1,3 +1,8 @@
+#
+# Copyright (c) Microsoft. All rights reserved.
+# Licensed under the MIT license. See LICENSE file in the project root for full license information.
+#
+
 <#
 .SYNOPSIS
     Add web route with method DELETE

Public/New-PolarisGetRoute.ps1

@@ -1,3 +1,8 @@
+#
+# Copyright (c) Microsoft. All rights reserved.
+# Licensed under the MIT license. See LICENSE file in the project root for full license information.
+#
+
 <#
 .SYNOPSIS
     Add web route with method GET
@@ -52,4 +57,3 @@ function New-PolarisGetRoute {
         'ScriptPath' { New-PolarisRoute -Path $Path -Method "GET" -ScriptPath  $ScriptPath  -Force:$Force }
     }
 }
-