From 9b8cedf6c695a81e03767ea8feec881b0c3ad29e Mon Sep 17 00:00:00 2001
From: Acruid <shatter66@gmail.com>
Date: Wed, 17 Jun 2020 18:19:31 -0700
Subject: [PATCH] Adds documentation to ISharedNotifyManager.

---
 .../Interfaces/ISharedNotifyManager.cs        | 24 ++++++++++++++++++-
 1 file changed, 23 insertions(+), 1 deletion(-)

diff --git a/Content.Shared/Interfaces/ISharedNotifyManager.cs b/Content.Shared/Interfaces/ISharedNotifyManager.cs
index 24ed109a2b..2dde0e7b50 100644
--- a/Content.Shared/Interfaces/ISharedNotifyManager.cs
+++ b/Content.Shared/Interfaces/ISharedNotifyManager.cs
@@ -1,13 +1,35 @@
-using Robust.Shared.Interfaces.GameObjects;
+using Robust.Shared.Interfaces.GameObjects;
 using Robust.Shared.IoC;
 using Robust.Shared.Map;
 
 namespace Content.Shared.Interfaces
 {
+    /// <summary>
+    /// Allows the ability to create floating text messages at locations in the world.
+    /// </summary>
     public interface ISharedNotifyManager
     {
+        /// <summary>
+        /// Makes a string of text float up from an entity.
+        /// </summary>
+        /// <param name="source">The entity that the message is floating up from.</param>
+        /// <param name="viewer">The client attached entity that the message is being sent to.</param>
+        /// <param name="message">Text contents of the message.</param>
         void PopupMessage(IEntity source, IEntity viewer, string message);
+
+        /// <summary>
+        /// Makes a string of text float up from a location on a grid.
+        /// </summary>
+        /// <param name="coordinates">Location on a grid that the message floats up from.</param>
+        /// <param name="viewer">The client attached entity that the message is being sent to.</param>
+        /// <param name="message">Text contents of the message.</param>
         void PopupMessage(GridCoordinates coordinates, IEntity viewer, string message);
+
+        /// <summary>
+        /// Makes a string of text float up from a client's cursor.
+        /// </summary>
+        /// <param name="viewer">The client attached entity that the message is being sent to.</param>
+        /// <param name="message">Text contents of the message.</param>
         void PopupMessageCursor(IEntity viewer, string message);
     }