Documentation

Author: mwagnerEE

Source/SVGImage/SVG/Shapes/LengthPercentageOrNumber.cs

@@ -9,6 +9,9 @@ public struct LengthPercentageOrNumber
         private static readonly Regex _lengthRegex = new Regex(@"(?<Value>\d+(?:\.\d+)?)\s*(?<Unit>%|\w+)?", RegexOptions.Compiled | RegexOptions.Singleline);
         private readonly LengthContext _context;
         private readonly double _value;
+        /// <summary>
+        /// Represents a length, percentage, or number value that has been resolved based on the context.
+        /// </summary>
         public double Value => ResolveValue();
 
 
@@ -130,15 +133,33 @@ private double ResolveValue()
             }
         }
         /// <summary>
-        /// 
+        /// Represents a length that may have a value that is context dependent.
         /// </summary>
-        /// <param name="value"></param>
-        /// <param name="context">If null, units will be ignored</param>
+        /// <param name="value">The numerical part of the length that is related to the <paramref name="context"/></param>
+        /// <param name="context">If <see langword="null"/>, units will be ignored</param>
         public LengthPercentageOrNumber(double value, LengthContext context)
         {
             _context = context;
             _value = value;
         }
+        /// <summary>
+        /// Parses a string representation of a length, percentage, or number value into a <see cref="LengthPercentageOrNumber"/> instance.
+        /// </summary>
+        /// <param name="owner">
+        /// The element that the length is associated with.
+        /// </param>
+        /// <param name="value">A string representation of a length</param>
+        /// <param name="orientation">Used to establish the context of the length.
+        /// Should be <see cref="LengthOrientation.Horizontal"/> for inherntly horizontal values like 'x' and 'dx'.
+        /// Should be <see cref="LengthOrientation.Vertical"/> for inherntly vertical values like 'y' and 'dy'.
+        /// Should be <see cref="LengthOrientation.None"/> for other values.
+        /// </param>
+        /// <returns>
+        /// A <see cref="LengthPercentageOrNumber"/> instance that represents the parsed value.
+        /// </returns>
+        /// <exception cref="ArgumentException">
+        /// Thrown when the provided value is not a valid length, percentage, or number.
+        /// </exception>
         public static LengthPercentageOrNumber Parse(Shape owner, string value, LengthOrientation orientation = LengthOrientation.None)
         {
             var lengthMatch = _lengthRegex.Match(value.Trim());

Source/SVGImage/SVG/Shapes/LengthPercentageOrNumberList.cs

@@ -18,6 +18,18 @@ private LengthPercentageOrNumberList(Shape owner, LengthOrientation orientation
             _owner = owner;
             _orientation = orientation;
         }
+        /// <summary>
+        /// Creates a new instance of LengthPercentageOrNumberList with the specified owner and orientation.
+        /// </summary>
+        /// <param name="owner">
+        /// The element that the length list is associated with.
+        /// </param>
+        /// <param name="value">A string representation of a length list</param>
+        /// <param name="orientation">Used to establish the context of the lengths.
+        /// Should be <see cref="LengthOrientation.Horizontal"/> for inherntly horizontal values like 'x' and 'dx'.
+        /// Should be <see cref="LengthOrientation.Vertical"/> for inherntly vertical values like 'y' and 'dy'.
+        /// Should be <see cref="LengthOrientation.None"/> for other values.
+        /// </param>
         public LengthPercentageOrNumberList(Shape owner, string value, LengthOrientation orientation = LengthOrientation.None) : this(owner, orientation)
         {
             Parse(value);

Source/SVGImage/SVG/Shapes/Text.cs

@@ -8,6 +8,9 @@ namespace SVGImage.SVG
     using Shapes;
     using System.Linq;
 
+    /// <summary>
+    /// The original TextShape class.
+    /// </summary>
     public sealed class TextShape2 : Shape
     {
         public TextShape2(SVG svg, XmlNode node, Shape parent)

Source/SVGImage/SVG/Shapes/TextPath.cs

@@ -3,6 +3,9 @@
 
 namespace SVGImage.SVG.Shapes
 {
+    /// <summary>
+    /// A placeholder class for TextPath.
+    /// </summary>
     internal class TextPath : TextShapeBase, ITextChild
     {
         protected TextPath(SVG svg, XmlNode node, Shape parent) : base(svg, node, parent)

Source/SVGImage/SVG/Shapes/TextRender.cs

@@ -8,10 +8,11 @@ namespace SVGImage.SVG.Shapes
     using System.Linq;
     using System.Windows.Markup;
 
+    /// <summary>
+    /// This class is responsible for rendering text shapes in SVG.
+    /// </summary>
     public sealed partial class TextRender : TextRenderBase
     {
-        
-
         public override GeometryGroup BuildTextGeometry(TextShape text)
         {
 

Source/SVGImage/SVG/Shapes/TextString.cs

@@ -6,14 +6,20 @@
 
     [DebuggerDisplay("{Text}")]
     /// <summary>
-    /// Text not wrapped in a tspan element.
+    /// The leaf of the Text tree
     /// </summary>
     public class TextString : ITextChild
     {
+        private static readonly Regex _trimmedWhitespace = new Regex(@"\s+", RegexOptions.Compiled | RegexOptions.Singleline);
+        /// <summary>
+        /// Represents the layout info for the string of text owned by this TextString.
+        /// </summary>
         public CharacterLayout[] Characters { get; set; }
         public Shape Parent { get; set; }
-        public int Index { get; set; }
-        private static readonly Regex _trimmedWhitespace = new Regex(@"\s+", RegexOptions.Compiled | RegexOptions.Singleline);
+        /// <summary>
+        /// The index of this TextString in the root TextShape. This is set by the <see cref="TextRender"/>.
+        /// </summary>
+        public int Index { get; internal set; }
         public TextString(Shape parent, string text)
         {
             Parent = parent;