From 784a046b3fcebd083bac187b26e792f2e79baa14 Mon Sep 17 00:00:00 2001
From: Anairkoen Schno <aaron.cirr.com@gmail.com>
Date: Tue, 11 Jun 2019 16:43:21 -0500
Subject: [PATCH] Fixed some docs

---
 BSIPA-ModList/UI/ViewControllers/MarkdownView.cs | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/BSIPA-ModList/UI/ViewControllers/MarkdownView.cs b/BSIPA-ModList/UI/ViewControllers/MarkdownView.cs
index c4fc338b..a0bc87bb 100644
--- a/BSIPA-ModList/UI/ViewControllers/MarkdownView.cs
+++ b/BSIPA-ModList/UI/ViewControllers/MarkdownView.cs
@@ -19,7 +19,7 @@ using System.Text.RegularExpressions;
 namespace BSIPA_ModList.UI.ViewControllers
 {
     /// <summary>
-    /// A UI component that renders Markdown in-game.
+    /// A UI component that renders CommonMark Markdown in-game.
     /// </summary>
     [RequireComponent(typeof(RectTransform))]
     public class MarkdownView : MonoBehaviour
@@ -35,6 +35,14 @@ namespace BSIPA_ModList.UI.ViewControllers
 
         private string markdown = "";
         private bool mdDirty = false;
+        
+        /// <summary>
+        /// The text to be rendered.
+        /// </summary>
+        /// <remarks>
+        /// When this is assigned, the object is marked dirty. It will re-render on the next Update tick.
+        /// </remarks>
+        /// <value>the text to render as Markdown</value>
         public string Markdown
         {
             get => markdown;