From 0a0e35646f6726b8d959f7dba9312eec4fc0c497 Mon Sep 17 00:00:00 2001
From: Steven Kirk <grokys@gmail.com>
Date: Fri, 24 Jul 2015 19:05:10 +0200
Subject: [PATCH] Documented Border.

Ported from ideas branch so some other changes came across too.
---
 Perspex.Controls/Border.cs | 103 ++++++++++++++++++++++++++-----------
 1 file changed, 72 insertions(+), 31 deletions(-)

diff --git a/Perspex.Controls/Border.cs b/Perspex.Controls/Border.cs
index c46017b111..e355228efb 100644
--- a/Perspex.Controls/Border.cs
+++ b/Perspex.Controls/Border.cs
@@ -1,67 +1,98 @@
 // -----------------------------------------------------------------------
 // <copyright file="Border.cs" company="Steven Kirk">
-// Copyright 2014 MIT Licence. See licence.md for more information.
+// Copyright 2015 MIT Licence. See licence.md for more information.
 // </copyright>
 // -----------------------------------------------------------------------
 
 namespace Perspex.Controls
 {
-    using System;
-    using System.Reactive.Linq;
-    using Perspex.Layout;
     using Perspex.Media;
 
+    /// <summary>
+    /// A control which decorates a child with a border and background.
+    /// </summary>
     public class Border : Decorator
     {
+        /// <summary>
+        /// Defines the <see cref="Background"/> property.
+        /// </summary>
         public static readonly PerspexProperty<Brush> BackgroundProperty =
-            PerspexProperty.Register<Border, Brush>("Background");
+            PerspexProperty.Register<Border, Brush>(nameof(Background));
 
+        /// <summary>
+        /// Defines the <see cref="BorderBrush"/> property.
+        /// </summary>
         public static readonly PerspexProperty<Brush> BorderBrushProperty =
-            PerspexProperty.Register<Border, Brush>("BorderBrush");
+            PerspexProperty.Register<Border, Brush>(nameof(BorderBrush));
 
+        /// <summary>
+        /// Defines the <see cref="BorderThickness"/> property.
+        /// </summary>
         public static readonly PerspexProperty<double> BorderThicknessProperty =
-            PerspexProperty.Register<Border, double>("BorderThickness");
+            PerspexProperty.Register<Border, double>(nameof(BorderThickness));
 
+        /// <summary>
+        /// Defines the <see cref="CornerRadius"/> property.
+        /// </summary>
         public static readonly PerspexProperty<float> CornerRadiusProperty =
-    PerspexProperty.Register<Border, float>("CornerRadius");
+            PerspexProperty.Register<Border, float>(nameof(CornerRadius));
 
+        /// <summary>
+        /// Initializes static members of the <see cref="Border"/> class.
+        /// </summary>
         static Border()
         {
             Control.AffectsRender(Border.BackgroundProperty);
             Control.AffectsRender(Border.BorderBrushProperty);
         }
 
+        /// <summary>
+        /// Gets or sets a brush with which to paint the background.
+        /// </summary>
         public Brush Background
         {
             get { return this.GetValue(BackgroundProperty); }
             set { this.SetValue(BackgroundProperty, value); }
         }
 
+        /// <summary>
+        /// Gets or sets a brush with which to paint the border.
+        /// </summary>
         public Brush BorderBrush
         {
             get { return this.GetValue(BorderBrushProperty); }
             set { this.SetValue(BorderBrushProperty, value); }
         }
 
+        /// <summary>
+        /// Gets or sets the thickness of the border.
+        /// </summary>
         public double BorderThickness
         {
             get { return this.GetValue(BorderThicknessProperty); }
             set { this.SetValue(BorderThicknessProperty, value); }
         }
 
+        /// <summary>
+        /// Gets or sets the radius of the border rounded corners.
+        /// </summary>
         public float CornerRadius
         {
             get { return this.GetValue(CornerRadiusProperty); }
             set { this.SetValue(CornerRadiusProperty, value); }
         }
 
+        /// <summary>
+        /// Renders the control.
+        /// </summary>
+        /// <param name="context">The drawing context.</param>
         public override void Render(IDrawingContext context)
         {
-            Brush background = this.Background;
-            Brush borderBrush = this.BorderBrush;
-            double borderThickness = this.BorderThickness;
-            float cornerRadius = this.CornerRadius;
-            Rect rect = new Rect(this.Bounds.Size).Deflate(this.BorderThickness);
+            var background = this.Background;
+            var borderBrush = this.BorderBrush;
+            var borderThickness = this.BorderThickness;
+            var cornerRadius = this.CornerRadius;
+            var rect = new Rect(this.Bounds.Size).Deflate(this.BorderThickness);
 
             if (background != null)
             {
@@ -74,33 +105,43 @@ namespace Perspex.Controls
             }
         }
 
-        protected override Size ArrangeOverride(Size finalSize)
-        {
-            Control content = this.Child;
-
-            if (content != null)
-            {
-                Thickness padding = this.Padding + new Thickness(this.BorderThickness);
-                content.Arrange(new Rect(finalSize).Deflate(padding));
-            }
-
-            return finalSize;
-        }
-
+        /// <summary>
+        /// Measures the control.
+        /// </summary>
+        /// <param name="availableSize">The available size.</param>
+        /// <returns>The desired size of the control.</returns>
         protected override Size MeasureOverride(Size availableSize)
         {
-            var content = this.Child;
+            var child = this.Child;
             var padding = this.Padding + new Thickness(this.BorderThickness);
 
-            if (content != null)
+            if (child != null)
             {
-                content.Measure(availableSize.Deflate(padding));
-                return content.DesiredSize.Inflate(padding);
+                child.Measure(availableSize.Deflate(padding));
+                return child.DesiredSize.Inflate(padding);
             }
             else
             {
                 return new Size(padding.Left + padding.Right, padding.Bottom + padding.Top);
             }
         }
+
+        /// <summary>
+        /// Arranges the control's child.
+        /// </summary>
+        /// <param name="finalSize">The size allocated to the control.</param>
+        /// <returns>The space taken.</returns>
+        protected override Size ArrangeOverride(Size finalSize)
+        {
+            var child = this.Child;
+
+            if (child != null)
+            {
+                var padding = this.Padding + new Thickness(this.BorderThickness);
+                child.Arrange(new Rect(finalSize).Deflate(padding));
+            }
+
+            return finalSize;
+        }
     }
-}
+}
\ No newline at end of file