Fix documentation loss

Author: Robert Holt

tools/postReleaseScripts/publishGHRelease.ps1

@@ -31,6 +31,14 @@ param(
 
 Import-Module "$PSScriptRoot/../GitHubTools.psm1" -Force
 
+<#
+.SYNOPSIS
+Get the release description from the CHANGELOG
+.DESCRIPTION
+Gets the latest CHANGELOG entry from the CHANGELOG for use as the GitHub release description
+.PARAMETER ChangelogPath
+Path to the changelog file
+#>
 function GetDescriptionFromChangelog
 {
     param(
@@ -40,7 +48,10 @@ function GetDescriptionFromChangelog
     )
 
     $lines = Get-Content -Path $ChangelogPath
+    # First two lines are the title and newline
+    # Third looks like '## vX.Y.Z-releasetag'
     $sb = [System.Text.StringBuilder]::new($lines[2])
+    # Read through until the next '## vX.Y.Z-releasetag' H2
     for ($i = 3; -not $lines[$i].StartsWith('## '); $i++)
     {
         $null = $sb.Append("`n").Append($lines[$i])