Document the Box properties

B3zaleel · Aug 11, 2019 · b511180 · b511180
1 parent 54b1851
commit b511180
Showing 1 changed file with 29 additions and 39 deletions.
diff --git a/src/WpfMath/Boxes/Box.cs b/src/WpfMath/Boxes/Box.cs
@@ -54,45 +54,35 @@ public Brush Background
 
         public object Tag{get; set;}
 
-        public double TotalHeight
-        {
-            get { return this.Height + this.Depth; }
-        }
-
-        public double TotalWidth
-        {
-            get { return this.Width + this.Italic; }
-        }
-
-        public double Italic
-        {
-            get;
-            set;
-        }
-
-        public double Width
-        {
-            get;
-            set;
-        }
-
-        public double Height
-        {
-            get;
-            set;
-        }
-
-        public double Depth
-        {
-            get;
-            set;
-        }
-
-        public double Shift
-        {
-            get;
-            set;
-        }
+        /// <summary>Total height of the box, including the <see cref="Depth"/>.</summary>
+        public double TotalHeight => Height + Depth;
+
+        /// <summary>Total width of the box, including the <see cref="Italic"/>.</summary>
+        public double TotalWidth => Width + Italic;
+
+        /// <summary>
+        /// The additional width of the box that is taken by italic elements (e.g. letter elements that are protruding
+        /// from the right of the base box.
+        /// </summary>
+        public double Italic { get; set; }
+
+        /// <summary>The base width of the box.</summary>
+        public double Width { get; set; }
+
+        /// <summary>The base height of the box.</summary>
+        public double Height { get; set; }
+
+        /// <summary>
+        /// The depth of the box: the height of the additional elements that are protruding from the bottom side of the
+        /// box.
+        /// </summary>
+        public double Depth { get; set; }
+
+        /// <summary>
+        /// The shift of the box: an auxiliary value that has a box-specific meaning (e.g. a vertical shift in a
+        /// <see cref="HorizontalBox"/>, or a horizontal shift in a <see cref="VerticalBox"/>).
+        /// </summary>
+        public double Shift { get; set; }
 
         public abstract void RenderTo(IElementRenderer renderer, double x, double y);