From ac8b0d789db42d59c320b2a8347c23b4becefe64 Mon Sep 17 00:00:00 2001
From: Jason Felds <jafelds@gmail.com>
Date: Thu, 19 May 2011 18:26:58 -0400
Subject: [PATCH] Move doxygen comment to header file.

---
 src/Song.cpp | 3 ---
 src/Song.h   | 6 ++++++
 2 files changed, 6 insertions(+), 3 deletions(-)

diff --git a/src/Song.cpp b/src/Song.cpp
index 8e65b68650..7f40c89a51 100644
--- a/src/Song.cpp
+++ b/src/Song.cpp
@@ -1151,9 +1151,6 @@ bool Song::HasEdits( StepsType st ) const
 	return false;
 }
 
-/* Return false if the song should not be displayed for selection in normal
- * gameplay (but may still be available in random selection, during extra
- * stages, or in other special conditions). */
 bool Song::NormallyDisplayed() const
 {
 	return UNLOCKMAN == NULL || !UNLOCKMAN->SongIsLocked(this);
diff --git a/src/Song.h b/src/Song.h
index 8d3134b0f2..70b4c20cb5 100644
--- a/src/Song.h
+++ b/src/Song.h
@@ -389,6 +389,12 @@ public:
 
 	void SetEnabled( bool b ) { m_bEnabled = b; }
 	bool GetEnabled() const { return m_bEnabled; }
+	/**
+	 * @brief Determine if the song should be shown on the MusicWheel normally.
+	 *
+	 * Songs that are not displayed normally may still be available during
+	 * random selection, extra stages, or other special conditions.
+	 * @return true if displayed normally, false otherwise. */
 	bool NormallyDisplayed() const;
 	bool ShowInDemonstrationAndRanking() const;