From 25b72971880093256d8773c19f950a8c470f1a9f Mon Sep 17 00:00:00 2001
From: Steven Kirk <grokys@users.noreply.github.com>
Date: Fri, 10 Aug 2018 21:46:11 +0200
Subject: [PATCH] Added RenderLoop docs.

---
 src/Avalonia.Visuals/Rendering/IRenderLoop.cs | 22 ++++++++++++++++++-
 src/Avalonia.Visuals/Rendering/RenderLoop.cs  | 20 +++++++++++++++++
 2 files changed, 41 insertions(+), 1 deletion(-)

diff --git a/src/Avalonia.Visuals/Rendering/IRenderLoop.cs b/src/Avalonia.Visuals/Rendering/IRenderLoop.cs
index bd1086d178..dd7442e7f8 100644
--- a/src/Avalonia.Visuals/Rendering/IRenderLoop.cs
+++ b/src/Avalonia.Visuals/Rendering/IRenderLoop.cs
@@ -1,8 +1,28 @@
 namespace Avalonia.Rendering
 {
+    /// <summary>
+    /// The application render loop.
+    /// </summary>
+    /// <remarks>
+    /// The render loop is responsible for advancing the animation timer and updating the scene
+    /// graph for visible windows.
+    /// </remarks>
     public interface IRenderLoop
     {
+        /// <summary>
+        /// Adds an update task.
+        /// </summary>
+        /// <param name="i">The update task.</param>
+        /// <remarks>
+        /// Registered update tasks will be polled on each tick of the render loop after the
+        /// animation timer has been pulsed.
+        /// </remarks>
         void Add(IRenderLoopTask i);
+
+        /// <summary>
+        /// Removes an update task.
+        /// </summary>
+        /// <param name="i">The update task.</param>
         void Remove(IRenderLoopTask i);
     }
-}
\ No newline at end of file
+}
diff --git a/src/Avalonia.Visuals/Rendering/RenderLoop.cs b/src/Avalonia.Visuals/Rendering/RenderLoop.cs
index 076e8bbd33..98fc12b4b1 100644
--- a/src/Avalonia.Visuals/Rendering/RenderLoop.cs
+++ b/src/Avalonia.Visuals/Rendering/RenderLoop.cs
@@ -5,6 +5,13 @@ using Avalonia.Threading;
 
 namespace Avalonia.Rendering
 {
+    /// <summary>
+    /// The application render loop.
+    /// </summary>
+    /// <remarks>
+    /// The render loop is responsible for advancing the animation timer and updating the scene
+    /// graph for visible windows.
+    /// </remarks>
     public class RenderLoop : IRenderLoop
     {
         private readonly IDispatcher _dispatcher;
@@ -12,17 +19,28 @@ namespace Avalonia.Rendering
         private IRenderTimer _timer;
         private bool inTick;
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="RenderLoop"/> class.
+        /// </summary>
         public RenderLoop()
         {
             _dispatcher = Dispatcher.UIThread;
         }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="RenderLoop"/> class.
+        /// </summary>
+        /// <param name="timer">The render timer.</param>
+        /// <param name="dispatcher">The UI thread dispatcher.</param>
         public RenderLoop(IRenderTimer timer, IDispatcher dispatcher)
         {
             _timer = timer;
             _dispatcher = dispatcher;
         }
 
+        /// <summary>
+        /// Gets the render timer.
+        /// </summary>
         protected IRenderTimer Timer
         {
             get
@@ -36,6 +54,7 @@ namespace Avalonia.Rendering
             }
         }
 
+        /// <inheritdoc/>
         public void Add(IRenderLoopTask i)
         {
             Contract.Requires<ArgumentNullException>(i != null);
@@ -49,6 +68,7 @@ namespace Avalonia.Rendering
             }
         }
 
+        /// <inheritdoc/>
         public void Remove(IRenderLoopTask i)
         {
             Contract.Requires<ArgumentNullException>(i != null);