mirror of
https://github.com/rbalsleyMSFT/FFU.git
synced 2026-06-14 02:09:35 -06:00
Docs: Add PowerShell comment-based help to all script modules
Adds standard PowerShell comment-based help blocks (synopsis and description) to all UI and common library script modules (`.psm1`) and the main UI entry point script (`.ps1`). This improves maintainability and discoverability by documenting the purpose of each script file. Also removes various redundant or commented-out code blocks.
This commit is contained in:
@@ -1,10 +1,13 @@
|
||||
# FFU Common Drivers Module
|
||||
# Contains shared functions related to driver handling.
|
||||
|
||||
# --------------------------------------------------------------------------
|
||||
# SECTION: Driver Compression Function
|
||||
# --------------------------------------------------------------------------
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Provides common functions for driver management, including compression, mapping, and existence checks.
|
||||
|
||||
.DESCRIPTION
|
||||
The FFU.Common.Drivers module contains a set of shared functions used across the FFU project for handling driver packages.
|
||||
This includes compressing driver folders into WIM files for efficient storage and deployment, maintaining a JSON-based mapping
|
||||
of downloaded drivers to their respective makes and models, and checking for the pre-existence of driver packages to avoid
|
||||
redundant downloads.
|
||||
#>
|
||||
function Compress-DriverFolderToWim {
|
||||
[CmdletBinding(SupportsShouldProcess)]
|
||||
param(
|
||||
|
||||
Reference in New Issue
Block a user