xml docs

src/SCFirstOrderLogic/TermIndexing/AsyncDiscriminationTree.cs

@@ -15,16 +15,19 @@ public class AsyncDiscriminationTree
     private readonly AsyncDiscriminationTree<Term> actualTree;
 
     /// <summary>
-    /// Initializes a new instance of the <see cref="AsyncDiscriminationTree"/> class that is empty to begin with.
+    /// Initializes a new instance of the <see cref="AsyncDiscriminationTree"/> class with a specified root node.
     /// </summary>
+    /// <param name="root">The root node of the tree.</param>
     public AsyncDiscriminationTree(IAsyncDiscriminationTreeNode<Term> root)
     {
         actualTree = new(root);
     }
 
     /// <summary>
-    /// Initializes a new instance of the <see cref="AsyncDiscriminationTree"/> class with some initial content.
+    /// Initializes a new instance of the <see cref="AsyncDiscriminationTree"/> class with a specified root node and some (additional) initial content.
     /// </summary>
+    /// <param name="root">The root node of the tree.</param>
+    /// <param name="content">The (additional) content to be added to the tree (beyond any already attached to the provided root node).</param>
     public AsyncDiscriminationTree(IAsyncDiscriminationTreeNode<Term> root, IEnumerable<Term> content)
     {
         actualTree = new(root, content.Select(t => KeyValuePair.Create(t, t)));

src/SCFirstOrderLogic/TermIndexing/AsyncDiscriminationTree{TValue}.cs

@@ -23,7 +23,7 @@ public class AsyncDiscriminationTree<TValue>
     private readonly IAsyncDiscriminationTreeNode<TValue> root;
 
     /// <summary>
-    /// Initializes a new instance of the <see cref="AsyncDiscriminationTree{TValue}"/> class that is empty to begin with.
+    /// Initializes a new instance of the <see cref="AsyncDiscriminationTree{TValue}"/> class with a specified root node.
     /// </summary>
     /// <param name="root">The root node of the tree.</param>
     public AsyncDiscriminationTree(IAsyncDiscriminationTreeNode<TValue> root)
@@ -32,10 +32,10 @@ public AsyncDiscriminationTree(IAsyncDiscriminationTreeNode<TValue> root)
     }
 
     /// <summary>
-    /// Initializes a new instance of the <see cref="AsyncDiscriminationTree{TValue}"/> class with some initial content.
+    /// Initializes a new instance of the <see cref="AsyncDiscriminationTree{TValue}"/> class with a specified root node and some (additional) initial content.
     /// </summary>
     /// <param name="root">The root node of the tree.</param>
-    /// <param name="content">The initial content to add to the tree.</param>
+    /// <param name="content">The (additional) content to be added to the tree (beyond any already attached to the provided root node).</param>
     public AsyncDiscriminationTree(IAsyncDiscriminationTreeNode<TValue> root, IEnumerable<KeyValuePair<Term, TValue>> content)
     {
         this.root = root ?? throw new ArgumentNullException(nameof(root));
@@ -106,7 +106,7 @@ public async Task AddAsync(Term term, TValue value)
         }
 
         // NB: can safely grab Value here because the current node must ALWAYS be a leaf node at this point.
-        // It is not possible for prefix element info enumerations to occur, because the the number of
+        // It is not possible for prefix element info enumerations to occur, because the number of
         // elements in the path is always one more than the summation of the ChildElementCounts (NB: used in
         // equality check) of all encountered elements.
         return (true, currentNode.Value);

src/SCFirstOrderLogic/TermIndexing/AsyncPathTree.cs

@@ -23,7 +23,7 @@ public class AsyncPathTree
     private readonly AsyncPathTree<Term> actualTree;
 
     /// <summary>
-    /// Initializes a new instance of the <see cref="AsyncPathTree"/> class with a specific root node.
+    /// Initializes a new instance of the <see cref="AsyncPathTree"/> class with a specified root node.
     /// </summary>
     /// <param name="rootNode">The root node of the tree.</param>
     public AsyncPathTree(IAsyncPathTreeParameterNode<Term> rootNode)
@@ -32,10 +32,10 @@ public AsyncPathTree(IAsyncPathTreeParameterNode<Term> rootNode)
     }
 
     /// <summary>
-    /// Initializes a new instance of the <see cref="PathTree"/> class with a specific root node and some initial content.
+    /// Initializes a new instance of the <see cref="PathTree"/> class with a specific root node and some (additional) initial content.
     /// </summary>
     /// <param name="rootNode">The root node of the tree.</param>
-    /// <param name="content">The initial content of the tree.</param>
+    /// <param name="content">The (additional) content to be added to the tree (beyond any already attached to the provided root node).</param>
     public AsyncPathTree(IAsyncPathTreeParameterNode<Term> rootNode, IEnumerable<Term> content)
     {
         actualTree = new(rootNode, content.Select(t => KeyValuePair.Create(t, t)));

src/SCFirstOrderLogic/TermIndexing/AsyncPathTree{TValue}.cs

@@ -30,7 +30,7 @@ public class AsyncPathTree<TValue>
     private readonly IAsyncPathTreeParameterNode<TValue> root;
 
     /// <summary>
-    /// Initializes a new instance of the <see cref="AsyncPathTree{TValue}"/> class with a specified root node and no (additional) initial content.
+    /// Initializes a new instance of the <see cref="AsyncPathTree{TValue}"/> class with a specified root node.
     /// </summary>
     /// <param name="rootNode">The root node of the tree.</param>
     public AsyncPathTree(IAsyncPathTreeParameterNode<TValue> rootNode)
@@ -39,10 +39,10 @@ public AsyncPathTree(IAsyncPathTreeParameterNode<TValue> rootNode)
     }
 
     /// <summary>
-    /// Initializes a new instance of the <see cref="AsyncPathTree{TValue}"/> class with a specified root node and some initial content.
+    /// Initializes a new instance of the <see cref="AsyncPathTree{TValue}"/> class with a specified root node and some (additional) initial content.
     /// </summary>
     /// <param name="rootNode">The root node of the tree.</param>
-    /// <param name="content">The initial content of the tree.</param>
+    /// <param name="content">The (additional) content to be added to the tree (beyond any already attached to the provided root node).</param>
     public AsyncPathTree(IAsyncPathTreeParameterNode<TValue> rootNode, IEnumerable<KeyValuePair<Term, TValue>> content)
     {
         this.root = rootNode ?? throw new ArgumentNullException(nameof(rootNode));

src/SCFirstOrderLogic/TermIndexing/DiscriminationTree.cs

@@ -20,7 +20,7 @@ public class DiscriminationTree
     private readonly DiscriminationTree<Term> actualTree;
 
     /// <summary>
-    /// Initializes a new instance of the <see cref="DiscriminationTree"/> class.
+    /// Initializes a new instance of the <see cref="DiscriminationTree"/> class with a new <see cref="DiscriminationTreeDictionaryNode{TValue}"/> root node and no initial content.
     /// </summary>
     public DiscriminationTree()
     {
@@ -30,22 +30,26 @@ public DiscriminationTree()
     /// <summary>
     /// Initializes a new instance of the <see cref="DiscriminationTree"/> class with a specified root node.
     /// </summary>
+    /// <param name="root">The root node of the tree.</param>
     public DiscriminationTree(IDiscriminationTreeNode<Term> root)
     {
         actualTree = new(root);
     }
 
     /// <summary>
-    /// Initializes a new instance of the <see cref="DiscriminationTree"/> class with some initial content.
+    /// Initializes a new instance of the <see cref="DiscriminationTree"/> class with a new <see cref="DiscriminationTreeDictionaryNode{TValue}"/> root node and some initial content.
     /// </summary>
+    /// <param name="content">The initial content to be added to the tree.</param>
     public DiscriminationTree(IEnumerable<Term> content)
     {
         actualTree = new(content.Select(t => KeyValuePair.Create(t, t)));
     }
 
     /// <summary>
-    /// Initializes a new instance of the <see cref="DiscriminationTree"/> class with a specified root node and some initial content.
+    /// Initializes a new instance of the <see cref="DiscriminationTree"/> class with a specified root node and some (additional) initial content.
     /// </summary>
+    /// <param name="root">The root node of the tree.</param>
+    /// <param name="content">The (additional) content to be added to the tree (beyond any already attached to the provided root node).</param>
     public DiscriminationTree(IDiscriminationTreeNode<Term> root, IEnumerable<Term> content)
     {
         actualTree = new(root, content.Select(t => KeyValuePair.Create(t, t)));

src/SCFirstOrderLogic/TermIndexing/DiscriminationTree{TValue}.cs

@@ -35,7 +35,7 @@ public DiscriminationTree()
     }
 
     /// <summary>
-    /// Initializes a new instance of the <see cref="DiscriminationTree{TValue}"/> class with a specified root node and no (additional) initial content.
+    /// Initializes a new instance of the <see cref="DiscriminationTree{TValue}"/> class with a specified root node.
     /// </summary>
     /// <param name="root">The root node of the tree.</param>
     public DiscriminationTree(IDiscriminationTreeNode<TValue> root)

src/SCFirstOrderLogic/TermIndexing/PathTree.cs

@@ -22,15 +22,15 @@ public class PathTree
     private readonly PathTree<Term> actualTree;
 
     /// <summary>
-    /// Initializes a new instance of the <see cref="PathTree"/> class.
+    /// Initializes a new instance of the <see cref="PathTree"/> class with a new <see cref="PathTreeDictionaryNode{TValue}"/> root node and no initial content.
     /// </summary>
     public PathTree()
     {
         actualTree = new();
     }
 
     /// <summary>
-    /// Initializes a new instance of the <see cref="PathTree"/> class with a specific root node.
+    /// Initializes a new instance of the <see cref="PathTree"/> class with a specified root node.
     /// </summary>
     /// <param name="rootNode">The root node of the tree.</param>
     public PathTree(IPathTreeParameterNode<Term> rootNode)
@@ -39,7 +39,7 @@ public PathTree(IPathTreeParameterNode<Term> rootNode)
     }
 
     /// <summary>
-    /// Initializes a new instance of the <see cref="PathTree"/> class with some initial content.
+    /// Initializes a new instance of the <see cref="PathTree"/> class with a new <see cref="PathTreeDictionaryNode{TValue}"/> root node and some initial content.
     /// </summary>
     /// <param name="content">The initial content of the tree.</param>
     public PathTree(IEnumerable<Term> content)
@@ -48,10 +48,10 @@ public PathTree(IEnumerable<Term> content)
     }
 
     /// <summary>
-    /// Initializes a new instance of the <see cref="PathTree"/> class with a specific root node and some initial content.
+    /// Initializes a new instance of the <see cref="PathTree"/> class with a specified root node and some (additional) initial content.
     /// </summary>
     /// <param name="rootNode">The root node of the tree.</param>
-    /// <param name="content">The initial content of the tree.</param>
+    /// <param name="content">The (additional) content to be added to the tree (beyond any already attached to the provided root node).</param>
     public PathTree(IPathTreeParameterNode<Term> rootNode, IEnumerable<Term> content)
     {
         actualTree = new(rootNode, content.Select(t => KeyValuePair.Create(t, t)));

src/SCFirstOrderLogic/TermIndexing/PathTree{TValue}.cs

@@ -35,7 +35,7 @@ public PathTree()
     }
 
     /// <summary>
-    /// Initializes a new instance of the <see cref="PathTree{TValue}"/> class with a specified root node and no (additional) initial content.
+    /// Initializes a new instance of the <see cref="PathTree{TValue}"/> class with a specified root node.
     /// </summary>
     /// <param name="rootNode">The root node of the tree.</param>
     public PathTree(IPathTreeParameterNode<TValue> rootNode)
@@ -53,10 +53,10 @@ public PathTree(IEnumerable<KeyValuePair<Term, TValue>> content)
     }
 
     /// <summary>
-    /// Initializes a new instance of the <see cref="PathTree{TValue}"/> class with a specified root node and some initial content.
+    /// Initializes a new instance of the <see cref="PathTree{TValue}"/> class with a specified root node and some (additional) initial content.
     /// </summary>
     /// <param name="rootNode">The root node of the tree.</param>
-    /// <param name="content">The initial content of the tree.</param>
+    /// <param name="content">The (additional) content to be added to the tree (beyond any already attached to the provided root node).</param>
     public PathTree(IPathTreeParameterNode<TValue> rootNode, IEnumerable<KeyValuePair<Term, TValue>> content)
     {
         this.root = rootNode ?? throw new ArgumentNullException(nameof(rootNode));