From e696d659d4f8d334098512806da40d59a7e56589 Mon Sep 17 00:00:00 2001
From: cosmonaut <evan@moonside.games>
Date: Fri, 15 Dec 2023 10:03:51 -0800
Subject: [PATCH] add comment for Font.Load

---
 src/Graphics/Font/Font.cs | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/src/Graphics/Font/Font.cs b/src/Graphics/Font/Font.cs
index b1af731..0dd6d1c 100644
--- a/src/Graphics/Font/Font.cs
+++ b/src/Graphics/Font/Font.cs
@@ -16,6 +16,11 @@ namespace MoonWorks.Graphics.Font
 		private byte* StringBytes;
 		private int StringBytesLength;
 
+		/// <summary>
+		/// Loads a TTF or OTF font from a path for use in MSDF rendering.
+		/// Note that there must be an msdf-atlas-gen JSON and image file alongside.
+		/// </summary>
+		/// <returns></returns>
 		public unsafe static Font Load(
 			GraphicsDevice graphicsDevice,
 			CommandBuffer commandBuffer,