From 1ea2c86bffdded3d14ac52802e3eb1844d5d339e Mon Sep 17 00:00:00 2001 From: Manuel Thalmann Date: Sun, 29 Sep 2024 17:39:26 +0200 Subject: [PATCH] Add missing documentation comments --- scripts/Windows/Scripts/PowerManagement.ps1 | 3 +++ scripts/Windows/Scripts/Registry.ps1 | 10 ++++++++++ scripts/Windows/Software/VisualStudio/Manage.ps1 | 3 +++ 3 files changed, 16 insertions(+) diff --git a/scripts/Windows/Scripts/PowerManagement.ps1 b/scripts/Windows/Scripts/PowerManagement.ps1 index e83e2933..9e8f8dbd 100644 --- a/scripts/Windows/Scripts/PowerManagement.ps1 +++ b/scripts/Windows/Scripts/PowerManagement.ps1 @@ -17,6 +17,9 @@ $null = New-Module { <# .SYNOPSIS Gets the reghistry key containing the `RunOnce` commands. + + .PARAMETER UserKey + The key of the user to get the `RunOnce` key for. #> function Get-RunOnceKey { param( diff --git a/scripts/Windows/Scripts/Registry.ps1 b/scripts/Windows/Scripts/Registry.ps1 index 1e4adbd7..bdd54eb3 100644 --- a/scripts/Windows/Scripts/Registry.ps1 +++ b/scripts/Windows/Scripts/Registry.ps1 @@ -40,6 +40,13 @@ $null = New-Module { [string] $finishedOption = "Finished"; [RegistryKey] $key = $null; + <# + .SYNOPSIS + Edits the `HKEY_CURRENT_USER` key of the default user using the specified action. + + .PARAMETER Action + The action to execute on the key. + #> function Edit-DefaultUserKey { param( [scriptblock] $Action @@ -353,6 +360,9 @@ $null = New-Module { <# .SYNOPSIS Sets a value indicating whether the setup has finished. + + .PARAMETER Value + The value to set the finished state to. #> function Set-IsFinished { param( diff --git a/scripts/Windows/Software/VisualStudio/Manage.ps1 b/scripts/Windows/Software/VisualStudio/Manage.ps1 index 4afad841..cb07ecaf 100644 --- a/scripts/Windows/Software/VisualStudio/Manage.ps1 +++ b/scripts/Windows/Software/VisualStudio/Manage.ps1 @@ -32,6 +32,9 @@ param( .SYNOPSIS Gets the path to the configuration file in the backup archive. + .PARAMETER Name + The name of the software. + .PARAMETER PackageName The name of the package to get the configuration for. #>