diff --git a/Scripts/Helpers/Get-FriendlyRegistryBackupTarget.ps1 b/Scripts/Helpers/Get-FriendlyRegistryBackupTarget.ps1 index 160ca17..5669e1a 100644 --- a/Scripts/Helpers/Get-FriendlyRegistryBackupTarget.ps1 +++ b/Scripts/Helpers/Get-FriendlyRegistryBackupTarget.ps1 @@ -1,3 +1,7 @@ +<# + .SYNOPSIS + Converts a registry-backup target identifier into a user-friendly label. +#> function Get-FriendlyRegistryBackupTarget { param( [AllowNull()] @@ -40,4 +44,4 @@ function Get-FriendlyRegistryBackupTarget { } return $Target -} \ No newline at end of file +} diff --git a/Scripts/Helpers/Get-FriendlyTargetUserName.ps1 b/Scripts/Helpers/Get-FriendlyTargetUserName.ps1 index d11f949..2be1024 100644 --- a/Scripts/Helpers/Get-FriendlyTargetUserName.ps1 +++ b/Scripts/Helpers/Get-FriendlyTargetUserName.ps1 @@ -1,3 +1,7 @@ +<# + .SYNOPSIS + Returns a readable description of the current app-removal target. +#> function Get-FriendlyTargetUserName { $target = Get-TargetUserForAppRemoval diff --git a/Scripts/Helpers/Get-RegFileOperations.ps1 b/Scripts/Helpers/Get-RegFileOperations.ps1 index c009e8a..3869db2 100644 --- a/Scripts/Helpers/Get-RegFileOperations.ps1 +++ b/Scripts/Helpers/Get-RegFileOperations.ps1 @@ -88,6 +88,10 @@ function Get-RegFileOperations { return $operations } +<# + .SYNOPSIS + Converts a .reg value literal into an operation type, registry value type, and data. +#> function Convert-RegValueData { param( [Parameter(Mandatory)] @@ -155,6 +159,10 @@ function Convert-RegValueData { return $null } +<# + .SYNOPSIS + Converts a comma-separated hexadecimal byte string into a byte array. +#> function Convert-HexStringToByteArray { param( [Parameter(Mandatory)] diff --git a/Scripts/Helpers/Get-UserName.ps1 b/Scripts/Helpers/Get-UserName.ps1 index 715d033..f3cd92a 100644 --- a/Scripts/Helpers/Get-UserName.ps1 +++ b/Scripts/Helpers/Get-UserName.ps1 @@ -1,3 +1,7 @@ +<# + .SYNOPSIS + Returns the explicitly targeted user name or the current process user name. +#> function Get-UserName { if ($script:Params.ContainsKey("User")) { return $script:Params.Item("User") diff --git a/Scripts/Helpers/Import-ConfigToParams.ps1 b/Scripts/Helpers/Import-ConfigToParams.ps1 index 645b933..3cecfc8 100644 --- a/Scripts/Helpers/Import-ConfigToParams.ps1 +++ b/Scripts/Helpers/Import-ConfigToParams.ps1 @@ -1,3 +1,7 @@ +<# + .SYNOPSIS + Imports valid application, tweak, and deployment selections from a configuration JSON file into active parameters. +#> function Import-ConfigToParams { param ( [Parameter(Mandatory = $true)]