Skip to content

Commit

Permalink
Update PackageManager.idl comments for async operations
Browse files Browse the repository at this point in the history
- Simplified documentation comments for RefreshPackageCatalogAsync,
AddPackageCatalogAsync, and RemovePackageCatalogAsync to specify
progress as a percentage (0-100).
- Removed detailed explanation
about progress reporting for "Microsoft.PreIndexed.Package"
Package Catalogs (implementation details).
  • Loading branch information
Madhusudhan-MSFT committed Oct 25, 2024
1 parent b5eae14 commit 340200a
Showing 1 changed file with 3 additions and 11 deletions.
14 changes: 3 additions & 11 deletions src/Microsoft.Management.Deployment/PackageManager.idl
Original file line number Diff line number Diff line change
Expand Up @@ -940,10 +940,7 @@ namespace Microsoft.Management.Deployment
[contract(Microsoft.Management.Deployment.WindowsPackageManagerContract, 12)]
{
/// Updates the package catalog.
/// The progress value, represented as a double, indicates the percentage of operation completion.
/// For "Microsoft.PreIndexed.Package" Package Catalogs, it reflects the progress of downloading and
/// installing the index. When there is no meaningful progress to report for other Package Catalogs,
/// the progress will be set to 0% at the start and will be updated to 100% upon the operation's completion.
/// The progress value, represented as a double, indicates the percentage of update package catalog operation completion.
/// The progress range is from 0 to 100.
Windows.Foundation.IAsyncOperationWithProgress<RefreshPackageCatalogResult, Double> RefreshPackageCatalogAsync();
}
Expand Down Expand Up @@ -1500,17 +1497,12 @@ namespace Microsoft.Management.Deployment
[contract(Microsoft.Management.Deployment.WindowsPackageManagerContract, 12)]
{
/// Add a catalog to the Windows Package Catalogs.
/// The progress value, represented as a double, indicates the percentage of operation completion.
/// For "Microsoft.PreIndexed.Package" Package Catalogs, it reflects the progress of downloading and
/// installing the index. When there is no meaningful progress to report for other Package Catalogs,
/// the progress will be set to 0% at the start and will be updated to 100% upon the operation's completion.
/// The progress value, represented as a double, indicates the percentage of add package catalog operation completion.
/// The progress range is from 0 to 100.
Windows.Foundation.IAsyncOperationWithProgress<AddPackageCatalogResult, Double> AddPackageCatalogAsync(AddPackageCatalogOptions options);

/// Unregisters a Package Catalog from the Windows Package Catalogs and eliminates the system artifacts based on the provided options.
/// The progress value, represented as a double, indicates the percentage of operation completion.For "Microsoft.PreIndexed.Package"
/// Package Catalogs, it reflects the progress of uninstalling the index. When there is no meaningful progress to report for
/// other Package Catalogs, the progress will be set to 0% at the start and will be updated to 100% upon the operation's completion.
/// The progress value, represented as a double, indicates the percentage of remove package catalog operation completion.
/// The progress range is from 0 to 100.
Windows.Foundation.IAsyncOperationWithProgress<RemovePackageCatalogResult, Double> RemovePackageCatalogAsync(RemovePackageCatalogOptions options);
}
Expand Down

0 comments on commit 340200a

Please sign in to comment.