Add missing documentation comments

This commit is contained in:
Manuel Thalmann 2024-09-29 17:39:26 +02:00
parent 9d24859ecf
commit 1ea2c86bff
3 changed files with 16 additions and 0 deletions

View file

@ -17,6 +17,9 @@ $null = New-Module {
<# <#
.SYNOPSIS .SYNOPSIS
Gets the reghistry key containing the `RunOnce` commands. Gets the reghistry key containing the `RunOnce` commands.
.PARAMETER UserKey
The key of the user to get the `RunOnce` key for.
#> #>
function Get-RunOnceKey { function Get-RunOnceKey {
param( param(

View file

@ -40,6 +40,13 @@ $null = New-Module {
[string] $finishedOption = "Finished"; [string] $finishedOption = "Finished";
[RegistryKey] $key = $null; [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 { function Edit-DefaultUserKey {
param( param(
[scriptblock] $Action [scriptblock] $Action
@ -353,6 +360,9 @@ $null = New-Module {
<# <#
.SYNOPSIS .SYNOPSIS
Sets a value indicating whether the setup has finished. Sets a value indicating whether the setup has finished.
.PARAMETER Value
The value to set the finished state to.
#> #>
function Set-IsFinished { function Set-IsFinished {
param( param(

View file

@ -32,6 +32,9 @@ param(
.SYNOPSIS .SYNOPSIS
Gets the path to the configuration file in the backup archive. Gets the path to the configuration file in the backup archive.
.PARAMETER Name
The name of the software.
.PARAMETER PackageName .PARAMETER PackageName
The name of the package to get the configuration for. The name of the package to get the configuration for.
#> #>