From 18125aac6a557788a5d87f8d53d2edc002ab3515 Mon Sep 17 00:00:00 2001
From: Siddharth singh chouhan <63919605+Sid672@users.noreply.github.com>
Date: Thu, 2 Sep 2021 13:35:33 +0530
Subject: [PATCH] Move documentation from implementations to declarations #2735
 (#2782)

---
 Source/spells.cpp | 11 -----------
 Source/spells.h   | 13 +++++++++++++
 2 files changed, 13 insertions(+), 11 deletions(-)

diff --git a/Source/spells.cpp b/Source/spells.cpp
index 9edb462dc..77109cae6 100644
--- a/Source/spells.cpp
+++ b/Source/spells.cpp
@@ -185,13 +185,6 @@ void UseMana(int id, spell_id sn)
 	}
 }
 
-/**
- * @brief Ensures the player's current readied spell is a valid selection for the character. If the current selection is
- * incompatible with the player's items and spell (for example, if the player does not currently have access to the spell),
- * the selection is cleared.
- * @note Will force a UI redraw in case the values actually change, so that the new spell reflects on the bottom panel.
- * @param player The player whose readied spell is to be checked.
- */
 void EnsureValidReadiedSpell(Player &player)
 {
 	if (!IsReadiedSpellValid(player)) {
@@ -248,10 +241,6 @@ void CastSpell(int id, int spl, int sx, int sy, int dx, int dy, int spllvl)
 	}
 }
 
-/**
- * @param pnum player index
- * @param rid target player index
- */
 void DoResurrect(int pnum, uint16_t rid)
 {
 	if (pnum == MyPlayerId) {
diff --git a/Source/spells.h b/Source/spells.h
index cc9b63f6e..63a35a11c 100644
--- a/Source/spells.h
+++ b/Source/spells.h
@@ -19,8 +19,21 @@ enum class SpellCheckResult : uint8_t {
 int GetManaAmount(Player &player, spell_id sn);
 void UseMana(int id, spell_id sn);
 SpellCheckResult CheckSpell(int id, spell_id sn, spell_type st, bool manaonly);
+
+/**
+ * @brief Ensures the player's current readied spell is a valid selection for the character. If the current selection is
+ * incompatible with the player's items and spell (for example, if the player does not currently have access to the spell),
+ * the selection is cleared.
+ * @note Will force a UI redraw in case the values actually change, so that the new spell reflects on the bottom panel.
+ * @param player The player whose readied spell is to be checked.
+ */
 void EnsureValidReadiedSpell(Player &player);
 void CastSpell(int id, int spl, int sx, int sy, int dx, int dy, int spllvl);
+
+/**
+ * @param pnum player index
+ * @param rid target player index
+ */
 void DoResurrect(int pnum, uint16_t rid);
 void DoHealOther(int pnum, uint16_t rid);
 int GetSpellBookLevel(spell_id s);