From a1bf5d99f78134acf1f36de09e2de3cc90696bb3 Mon Sep 17 00:00:00 2001
From: Jason Felds <jafelds@gmail.com>
Date: Mon, 9 May 2011 14:23:05 -0400
Subject: [PATCH] More doxygen catchup.

---
 src/ScreenEdit.h | 53 ++++++++++++++++++++++++++++--------------------
 1 file changed, 31 insertions(+), 22 deletions(-)

diff --git a/src/ScreenEdit.h b/src/ScreenEdit.h
index c9bf604ffb..ea10ca22a2 100644
--- a/src/ScreenEdit.h
+++ b/src/ScreenEdit.h
@@ -128,8 +128,7 @@ enum EditButton
 	EDIT_BUTTON_SAMPLE_LENGTH_UP,
 	EDIT_BUTTON_SAMPLE_LENGTH_DOWN,
 
-	// This modifies offset, BPM, and stop segment changes.
-	EDIT_BUTTON_ADJUST_FINE,
+	EDIT_BUTTON_ADJUST_FINE, /**< This button modifies offset, BPM, and stop segment changes. */
 
 	EDIT_BUTTON_SAVE, /**< Save the present changes into the chart. */
 
@@ -166,7 +165,9 @@ struct MapEditToDI
 	}
 };
 
-// Like MapEditToDI, but maps GameButton instead of DeviceInput.
+/**
+ * @brief This is similar to MapEditToDI,
+ * but maps GameButton instead of DeviceInput. */
 struct MapEditButtonToMenuButton
 {
 	GameButton button[NUM_EditButton][NUM_EDIT_TO_MENU_SLOTS];
@@ -214,11 +215,14 @@ protected:
 
 	// Call this before modifying m_NoteDataEdit.
 	void SaveUndo();
-	// Revert m_NoteDataEdit using m_Undo.
+	/** @brief Revert the last change made to m_NoteDataEdit. */
 	void Undo();
+	/** @brief Remove the previously stored NoteData to prevent undoing. */
 	void ClearUndo();
-	// Call this after modifying m_NoteDataEdit.  It will Undo() if 
-	// MAX_NOTES_PER_MEASURE was exceeded.
+	/**
+	 * @brief This is to be called after modifying m_NoteDataEdit.
+	 *
+	 * It will Undo itself if MAX_NOTES_PER_MEASURE was exceeded. */
 	void CheckNumberOfNotesAndUndo();
 
 	void OnSnapModeChange();
@@ -252,7 +256,10 @@ protected:
 
 	// keep track of where we are and what we're doing
 	float			m_fTrailingBeat; // this approaches GAMESTATE->m_fSongBeat, which is the actual beat
-	// The location we were at when shift was pressed, or -1 when shift isn't pressed:
+	/**
+	 * @brief The location we were at when shift was pressed.
+	 *
+	 * If shift wasn't pressed, this will be -1. */
 	int			m_iShiftAnchor;
 
 	/** @brief The NoteData that has been cut or copied. */
@@ -311,22 +318,23 @@ protected:
 	ThemeMetric<EditMode> EDIT_MODE;
 
 public:
+	/** @brief What are the choices that one can make on the main menu? */
 	enum MainMenuChoice
 	{
 		play_selection,
 		set_selection_start,
 		set_selection_end,
 		edit_steps_information,
-		play_whole_song,
+		play_whole_song, /**< Play the entire chart from the beginning. */
 		play_selection_start_to_end,
 		play_current_beat_to_end,
-		save,
+		save, /**< Save the current chart to disk. */
 		revert_to_last_save,
 		revert_from_disk,
-		options,
-		edit_song_info,
-		edit_timing_data,
-		play_preview_music,
+		options, /**< Modify the PlayerOptions and SongOptions. */
+		edit_song_info, /**< Edit some general information about the song. */
+		edit_timing_data, /**< Edit the chart's timing data. */
+		play_preview_music, /**< Play the song's preview music. */
 		exit,
 		save_on_exit,
 		NUM_MAIN_MENU_CHOICES,
@@ -361,13 +369,14 @@ public:
 	};
 	void HandleAreaMenuChoice( AreaMenuChoice c, const vector<int> &iAnswers, bool bAllowUndo = true );
 	void HandleAreaMenuChoice( AreaMenuChoice c, bool bAllowUndo = true ) { const vector<int> v; HandleAreaMenuChoice( c, v, bAllowUndo ); }
+	/** @brief How should the selected notes be transformed? */
 	enum TurnType
 	{
-		left,
-		right,
-		mirror,
-		shuffle, 
-		super_shuffle, 
+		left, /**< Turn the notes as if you were facing to the left. */
+		right, /**< Turn the notes as if you were facing to the right. */
+		mirror, /**< Turn the notes as if you were facing away from the machine. */
+		shuffle, /**< Replace one column with another column. */
+		super_shuffle, /**< Replace each note individually. */
 		NUM_TURN_TYPES 
 	};
 	enum TransformType
@@ -421,10 +430,10 @@ public:
 	{
 		difficulty,
 		meter,
-		description,
-		chartstyle,
-		step_credit,
-		predict_meter,
+		description, /**< What is the description of this chart? */
+		chartstyle, /**< How is this chart meant to be played? */
+		step_credit, /**< Who wrote this individual chart? */
+		predict_meter, /**< What does the game think this chart's rating should be? */
 		tap_notes,
 		jumps,
 		hands,