aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorRob Mensching <rob@firegiant.com>2021-03-25 21:59:47 -0700
committerRob Mensching <rob@firegiant.com>2021-03-25 22:01:03 -0700
commitf85e509dcb6da33c22f45ee27eff428398bbacf2 (patch)
tree17898d870643cd95f40862393a882d7a2fd8df0f /src
parent6c58ee03306e50e44c6a7f57a991da9572811c49 (diff)
downloadwix-f85e509dcb6da33c22f45ee27eff428398bbacf2.tar.gz
wix-f85e509dcb6da33c22f45ee27eff428398bbacf2.tar.bz2
wix-f85e509dcb6da33c22f45ee27eff428398bbacf2.zip
Add XML doc to IVariableResolution
Diffstat (limited to 'src')
-rw-r--r--src/WixToolset.Extensibility/Services/IVariableResolution.cs16
1 files changed, 15 insertions, 1 deletions
diff --git a/src/WixToolset.Extensibility/Services/IVariableResolution.cs b/src/WixToolset.Extensibility/Services/IVariableResolution.cs
index 82bacb31..adcec47f 100644
--- a/src/WixToolset.Extensibility/Services/IVariableResolution.cs
+++ b/src/WixToolset.Extensibility/Services/IVariableResolution.cs
@@ -2,15 +2,29 @@
2 2
3namespace WixToolset.Extensibility.Services 3namespace WixToolset.Extensibility.Services
4{ 4{
5#pragma warning disable 1591 // TODO: add documentation 5 /// <summary>
6 /// Result when resolving a variable.
7 /// </summary>
6 public interface IVariableResolution 8 public interface IVariableResolution
7 { 9 {
10 /// <summary>
11 /// Indicates if the value contains variables that cannot be resolved yet.
12 /// </summary>
8 bool DelayedResolve { get; set; } 13 bool DelayedResolve { get; set; }
9 14
15 /// <summary>
16 /// Indicates whether a bind variables default value was used in the resolution.
17 /// </summary>
10 bool IsDefault { get; set; } 18 bool IsDefault { get; set; }
11 19
20 /// <summary>
21 /// Indicates whether the resolution updated the value.
22 /// </summary>
12 bool UpdatedValue { get; set; } 23 bool UpdatedValue { get; set; }
13 24
25 /// <summary>
26 /// The resolved value.
27 /// </summary>
14 string Value { get; set; } 28 string Value { get; set; }
15 } 29 }
16} 30}