From 2d3fb4408988fe701bbad90785a2ed13e388bad8 Mon Sep 17 00:00:00 2001
From: "coderabbitai[bot]"
 <136622811+coderabbitai[bot]@users.noreply.github.com>
Date: Tue, 15 Jul 2025 21:48:02 +0000
Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Add=20docstrings=20to=20`dev`?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Docstrings generation was requested by @AlexInABox.

* https://github.com/AlexInABox/RoundReports/pull/7#issuecomment-3075830649

The following files were modified:

* `RoundReports/Reporter.cs`
---
 RoundReports/Reporter.cs | 14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)

diff --git a/RoundReports/Reporter.cs b/RoundReports/Reporter.cs
index 7f749cd..6e2c102 100644
--- a/RoundReports/Reporter.cs
+++ b/RoundReports/Reporter.cs
@@ -1,4 +1,4 @@
-namespace RoundReports
+namespace RoundReports
 {
     using System;
     using System.Collections;
@@ -513,7 +513,12 @@ private IEnumerator<float> SendReportInternal()
         /// Huge method for handling the upload to Pastee and Discord, as well as the in-game broadcasts.
         /// </summary>
         /// <param name="iter">The current iteration of the method. Upload will be canceled if this reaches 10.</param>
-        /// <returns>Coroutine.</returns>
+        /// <summary>
+        /// Attempts to upload the round report to Pastee and send notifications to Discord and in-game broadcasts, retrying up to 10 times on failure.
+        /// </summary>
+        /// <param name="data">The report data to upload.</param>
+        /// <param name="iter">The current retry attempt count (default is 0).</param>
+        /// <returns>An enumerator for coroutine execution.</returns>
         private IEnumerator<float> TryUpload(PasteEntry data, int iter = 0)
         {
             Log.Debug("Beginning report upload process.");
@@ -678,6 +683,11 @@ private IEnumerator<float> TryUpload(PasteEntry data, int iter = 0)
             }
         }
 
+        /// <summary>
+        /// Replaces placeholders in the input string with corresponding round report values, such as MVPs, kill counts, times, and report metadata.
+        /// </summary>
+        /// <param name="input">The string containing placeholders to be replaced with report data.</param>
+        /// <returns>The input string with all recognized placeholders replaced by their current values.</returns>
         private string ProcessReportArgs(string input)
         {
             FinalStats final = GetStat<FinalStats>();