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,3 +1,21 @@
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Launches the FFU Development UI, a WPF application for configuring and running the FFU build process.
|
||||
.DESCRIPTION
|
||||
The BuildFFUVM_UI.ps1 script is the main entry point for the FFU Development user interface. It initializes and displays a WPF-based graphical interface defined in BuildFFUVM_UI.xaml.
|
||||
|
||||
The script is responsible for:
|
||||
- Initializing a global state object to manage UI controls, data, and application flags.
|
||||
- Importing the required FFU.Common and FFUUI.Core modules which contain the business logic.
|
||||
- Ensuring system prerequisites, such as PowerShell 7 and Long Path Support, are met.
|
||||
- Loading the XAML window, initializing UI controls with default values, and registering all event handlers.
|
||||
- Launching the core build script (BuildFFUVM.ps1) in a background job when the user initiates a build.
|
||||
- Providing real-time feedback by monitoring the build log file and updating the UI's progress bar and log viewer.
|
||||
- Handling cleanup operations, such as reverting system settings, when the application is closed.
|
||||
|
||||
This script acts as the primary host for the UI, connecting the user interface with the underlying build and logic modules.
|
||||
#>
|
||||
|
||||
[CmdletBinding()]
|
||||
[System.STAThread()]
|
||||
param()
|
||||
|
||||
Reference in New Issue
Block a user