cleanup/comment

src/ScreenOptions.h

@@ -85,14 +85,16 @@ protected:
 
 	int GetCurrentRow( PlayerNumber pn = PLAYER_1 ) const { return m_iCurrentRow[pn]; }
 	bool AllAreOnLastRow() const;
+	OptionRow* GetRow( int iRow ) const { return m_pRows[iRow]; }
 
 protected:	// derived classes need access to these
 	enum Navigation { NAV_THREE_KEY, NAV_THREE_KEY_MENU, NAV_THREE_KEY_ALT, NAV_FIVE_KEY, NAV_TOGGLE_THREE_KEY, NAV_TOGGLE_FIVE_KEY };
 	void SetNavigation( Navigation nav ) { m_OptionsNavigation = nav; }
 	void SetInputMode( InputMode im ) { m_InputMode = im; }
 
-	// Map menu lines to m_OptionRow entries.
+	/** @brief Map menu lines to m_OptionRow entries. */
 	vector<OptionRow*>	m_pRows;
+	/** @brief The current row each player is on. */
 	int			m_iCurrentRow[NUM_PLAYERS];
 
 	OptionRowType	m_OptionRowTypeNormal;
@@ -104,9 +106,10 @@ protected:	// derived classes need access to these
 	int				m_iFocusX[NUM_PLAYERS];
 	bool			m_bWasOnExit[NUM_PLAYERS];
 
-	// TRICKY: People hold Start to get to PlayerOptions, then 
-	// the repeat events cause them to zip to the bottom.  So, ignore
-	// Start repeat events until we've seen one first pressed event.
+	/** @brief True if at least one player pressed Start after selecting the song.
+	 * TRICKY: People hold Start to get to PlayerOptions, then the repeat events
+	 * cause them to zip to the bottom. So, ignore Start repeat events until
+	 * we've seen one first pressed event. */
 	bool			m_bGotAtLeastOneStartPressed[NUM_PLAYERS];
 
 	// actors