Add docstrings

This commit is contained in:
Jeffrey 2026-07-19 19:17:43 +02:00
parent 2af10029a0
commit c3e9ef5fb5
No known key found for this signature in database
5 changed files with 25 additions and 1 deletions

View File

@ -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
}
}

View File

@ -1,3 +1,7 @@
<#
.SYNOPSIS
Returns a readable description of the current app-removal target.
#>
function Get-FriendlyTargetUserName {
$target = Get-TargetUserForAppRemoval

View File

@ -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)]

View File

@ -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")

View File

@ -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)]