Add comments, fix a namespace (ForNeVeR#149)

NikolaiSviridov · Jan 6, 2020 · 3940d1c · 3940d1c
1 parent fbcf311
commit 3940d1c
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/src/WpfMath/Parsers/AtomAppendMode.cs b/src/WpfMath/Parsers/AtomAppendMode.cs
@@ -1,8 +1,13 @@
-namespace WpfMath
+namespace WpfMath.Parsers
 {
+    /// <summary>An enumeration that describes how an atom generated by a command should be handled.</summary>
     internal enum AtomAppendMode
     {
+        /// <summary>A new atom will be added to the end of the current formula.</summary>
         Add,
+
+        /// <summary>A new atom will replace an entire existing formula.</summary>
+        /// <remarks>Useful for commands that wrap or somehow process the existing formula.</remarks>
         Replace
     }
 }
diff --git a/src/WpfMath/Parsers/CommandParsers.cs b/src/WpfMath/Parsers/CommandParsers.cs
@@ -57,6 +57,10 @@ internal class CommandProcessingResult
         /// </summary>
         public int NextPosition { get; }
 
+        /// <summary>
+        /// Controls how an atom generated by this command should be handled: should it be added to the end of an
+        /// existing formula, or should it replace the formula completely.
+        /// </summary>
         public AtomAppendMode AppendMode { get; }
 
         public CommandProcessingResult(Atom atom, int nextPosition, AtomAppendMode appendMode = AtomAppendMode.Add)