Browse Source

Fixed some docs

pull/13/head
Anairkoen Schno 5 years ago
parent
commit
d2fa4dc688
1 changed files with 9 additions and 1 deletions
  1. +9
    -1
      BSIPA-ModList/UI/ViewControllers/MarkdownView.cs

+ 9
- 1
BSIPA-ModList/UI/ViewControllers/MarkdownView.cs View File

@ -19,7 +19,7 @@ using System.Text.RegularExpressions;
namespace BSIPA_ModList.UI.ViewControllers namespace BSIPA_ModList.UI.ViewControllers
{ {
/// <summary> /// <summary>
/// A UI component that renders Markdown in-game.
/// A UI component that renders CommonMark Markdown in-game.
/// </summary> /// </summary>
[RequireComponent(typeof(RectTransform))] [RequireComponent(typeof(RectTransform))]
public class MarkdownView : MonoBehaviour public class MarkdownView : MonoBehaviour
@ -35,6 +35,14 @@ namespace BSIPA_ModList.UI.ViewControllers
private string markdown = ""; private string markdown = "";
private bool mdDirty = false; 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 public string Markdown
{ {
get => markdown; get => markdown;


Loading…
Cancel
Save