Add XML doc to IVariableResolution
Rob Mensching committed
Mar 25, 2021 at 21:59 UTC
f85e509dcb6da33c22f45ee27eff428398bbacf2
1 file changed
+15
-1
src/WixToolset.Extensibility/Services/IVariableResolution.cs
+15
-1
@@ -2,15 +2,29 @@
2
3
namespace WixToolset.Extensibility.Services
4
{
5
-#pragma warning disable 1591 // TODO: add documentation
5
+ /// <summary>
6
+ /// Result when resolving a variable.
7
+ /// </summary>
8
public interface IVariableResolution
9
{
10
+ /// <summary>
11
+ /// Indicates if the value contains variables that cannot be resolved yet.
12
+ /// </summary>
13
bool DelayedResolve { get; set; }
14
15
+ /// <summary>
16
+ /// Indicates whether a bind variables default value was used in the resolution.
17
+ /// </summary>
18
bool IsDefault { get; set; }
19
20
+ /// <summary>
21
+ /// Indicates whether the resolution updated the value.
22
+ /// </summary>
23
bool UpdatedValue { get; set; }
24
25
+ /// <summary>
26
+ /// The resolved value.
27
+ /// </summary>
28
string Value { get; set; }
29
}
30
}