From 6c58ee03306e50e44c6a7f57a991da9572811c49 Mon Sep 17 00:00:00 2001
From: Rob Mensching <rob@firegiant.com>
Date: Tue, 16 Mar 2021 16:10:25 -0700
Subject: Make ResetAcl opt-in instead of opt-out

---
 .../Data/ILayoutContext.cs                         | 36 ++++++++++++++++++++--
 1 file changed, 34 insertions(+), 2 deletions(-)

(limited to 'src/WixToolset.Extensibility/Data')

diff --git a/src/WixToolset.Extensibility/Data/ILayoutContext.cs b/src/WixToolset.Extensibility/Data/ILayoutContext.cs
index 6b6c280a..3d49b877 100644
--- a/src/WixToolset.Extensibility/Data/ILayoutContext.cs
+++ b/src/WixToolset.Extensibility/Data/ILayoutContext.cs
@@ -6,27 +6,59 @@ namespace WixToolset.Extensibility.Data
     using System.Collections.Generic;
     using System.Threading;
 
-#pragma warning disable 1591 // TODO: add documentation
+    /// <summary>
+    /// Context for laying out files.
+    /// </summary>
     public interface ILayoutContext
     {
+        /// <summary>
+        /// Service provider.
+        /// </summary>
         IServiceProvider ServiceProvider { get; }
 
+        /// <summary>
+        /// Extensions for use during layout.
+        /// </summary>
         IEnumerable<ILayoutExtension> Extensions { get; set; }
 
+        /// <summary>
+        /// Set of tracked of files created during processing to be cleaned up.
+        /// </summary>
         IEnumerable<ITrackedFile> TrackedFiles { get; set; }
 
+        /// <summary>
+        /// Set of files to transfer.
+        /// </summary>
         IEnumerable<IFileTransfer> FileTransfers { get; set; }
 
+        /// <summary>
+        /// File to capture list of content files.
+        /// </summary>
         string ContentsFile { get; set; }
 
+        /// <summary>
+        /// File to capture list of output files.
+        /// </summary>
         string OutputsFile { get; set; }
 
+        /// <summary>
+        /// Intermediate folder.
+        /// </summary>
         string IntermediateFolder { get; set; }
 
+        /// <summary>
+        /// List of built output files.
+        /// </summary>
         string BuiltOutputsFile { get; set; }
 
-        bool SuppressAclReset { get; set; }
+        /// <summary>
+        /// Reset ACLs on file transfers.
+        /// </summary>
+        bool ResetAcls { get; set; }
 
+        /// <summary>
+        /// Cancellation token.
+        /// </summary>
         CancellationToken CancellationToken { get; set; }
     }
 }
-- 
cgit v1.2.3-55-g6feb