Skip to content

Commit 0ec1096

Browse files
committed
Update docstrings
1 parent 9f10bc5 commit 0ec1096

3 files changed

Lines changed: 14 additions & 4 deletions

File tree

Scripts/Features/Backup-RegistrySnapshotCapture.ps1

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,8 @@ function Get-RegistryKeySnapshot {
201201
202202
.DESCRIPTION
203203
Captures all values or selected value names, records missing selected values,
204-
and recursively captures subkeys when requested.
204+
and recursively captures subkeys when requested. Throws if a requested subkey
205+
cannot be read.
205206
#>
206207
function Convert-RegistryKeyToSnapshot {
207208
param(

Scripts/Features/Invoke-Changes.ps1

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -302,8 +302,8 @@ function Invoke-UndoFeatures {
302302
303303
.DESCRIPTION
304304
Sequenced in four phases:
305-
1. Registry backup
306-
2. System restore point
305+
1. Registry backup (skipped when SkipRegistryBackup is present)
306+
2. System restore point (skipped when CreateRestorePoint is absent)
307307
3. Apply phase - applies all selected features via Invoke-ApplyFeatures
308308
4. Undo phase - undoes selected features via Invoke-UndoFeatures
309309

Scripts/Features/Restore-RegistryApplyState.ps1

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,10 @@ function Restore-RegistryKeySnapshot {
7171

7272
<#
7373
.SYNOPSIS
74-
Validates all registry values in a snapshot before live registry state is changed.
74+
Validates registry values and subkey paths in a snapshot before live registry state is changed.
75+
76+
.PARAMETER Snapshot
77+
The registry key snapshot to validate before it is restored.
7578
#>
7679
function Test-RegistryKeySnapshotCanBeRestored {
7780
param(
@@ -101,6 +104,12 @@ function Test-RegistryKeySnapshotCanBeRestored {
101104
<#
102105
.SYNOPSIS
103106
Returns a snapshot child's name only when it is directly below its parent.
107+
108+
.PARAMETER ParentPath
109+
The registry path of the expected parent snapshot.
110+
111+
.PARAMETER ChildPath
112+
The registry path of the child snapshot to validate.
104113
#>
105114
function Get-DirectRegistrySnapshotChildName {
106115
param(

0 commit comments

Comments
 (0)