From a0dd2bc561ee6aa6b7aebedcff76c8a11e14bc9f Mon Sep 17 00:00:00 2001
From: Rob Mensching <rob@firegiant.com>
Date: Fri, 26 Mar 2021 15:38:00 -0700
Subject: Make the IntermediateSection and IntermediateSymbol less mutable

---
 src/WixToolset.Data/IntermediateSymbol.cs | 53 ++++++++++++++++++++++++++++---
 1 file changed, 49 insertions(+), 4 deletions(-)

(limited to 'src/WixToolset.Data/IntermediateSymbol.cs')

diff --git a/src/WixToolset.Data/IntermediateSymbol.cs b/src/WixToolset.Data/IntermediateSymbol.cs
index 408be37c..4be17094 100644
--- a/src/WixToolset.Data/IntermediateSymbol.cs
+++ b/src/WixToolset.Data/IntermediateSymbol.cs
@@ -6,15 +6,28 @@ namespace WixToolset.Data
     using System.Diagnostics;
     using SimpleJson;
 
+    /// <summary>
+    /// Intermediate symbol.
+    /// </summary>
     [DebuggerDisplay("{DebuggerDisplay,nq}")]
     public class IntermediateSymbol
     {
         private object tags;
 
+        /// <summary>
+        /// Creates an intermediate symbol.
+        /// </summary>
+        /// <param name="definition">Symbol definition.</param>
         public IntermediateSymbol(IntermediateSymbolDefinition definition) : this(definition, null, null)
         {
         }
 
+        /// <summary>
+        /// Creates an intermediate symbol with source line number and identifier. 
+        /// </summary>
+        /// <param name="definition">Symbol definition.</param>
+        /// <param name="sourceLineNumber">Source line number.</param>
+        /// <param name="id">Symbol identifier.</param>
         public IntermediateSymbol(IntermediateSymbolDefinition definition, SourceLineNumber sourceLineNumber, Identifier id = null)
         {
             this.Definition = definition;
@@ -23,18 +36,40 @@ namespace WixToolset.Data
             this.Id = id;
         }
 
+        /// <summary>
+        /// Gets the symbol's definition.
+        /// </summary>
         public IntermediateSymbolDefinition Definition { get; }
 
+        /// <summary>
+        /// Gets the symbol's fields.
+        /// </summary>
         public IntermediateField[] Fields { get; }
 
-        public SourceLineNumber SourceLineNumbers { get; set; }
-
-        public Identifier Id { get; set; }
-
+        /// <summary>
+        /// Gets the optional source line number of the symbol.
+        /// </summary>
+        public SourceLineNumber SourceLineNumbers { get; internal set; }
+
+        /// <summary>
+        /// Gets the optional identifier for the symbol.
+        /// </summary>
+        public Identifier Id { get; internal set; }
+
+        /// <summary>
+        /// Direct access by index to the symbol's fields.
+        /// </summary>
+        /// <param name="index">Index of the field to access.</param>
+        /// <returns>Symbol's field.</returns>
         public IntermediateField this[int index] => this.Fields[index];
 
         private string DebuggerDisplay => $"{this.Definition?.Name} {this.Id?.Id}";
 
+        /// <summary>
+        /// Add a custom tag to the symbol.
+        /// </summary>
+        /// <param name="add">String tag to add to the symbol.</param>
+        /// <returns>True if the tag was added; otherwise false if th tag was already present.</returns>
         public bool AddTag(string add)
         {
             if (this.tags == null)
@@ -73,6 +108,11 @@ namespace WixToolset.Data
             return true;
         }
 
+        /// <summary>
+        /// Tests whether a symbol has a tag.
+        /// </summary>
+        /// <param name="has">String tag to find.</param>
+        /// <returns>True if the symbol has the tag; otherwise false.</returns>
         public bool HasTag(string has)
         {
             if (this.tags == null)
@@ -97,6 +137,11 @@ namespace WixToolset.Data
             return false;
         }
 
+        /// <summary>
+        /// Removes a tag from the symbol.
+        /// </summary>
+        /// <param name="remove">String tag to remove.</param>
+        /// <returns>True if the tag was removed; otherwise false if the tag was not present.</returns>
         public bool RemoveTag(string remove)
         {
             if (this.tags is string tag)
-- 
cgit v1.2.3-55-g6feb