From 59b186d72f87c32e9355c081d0babe5151712dde Mon Sep 17 00:00:00 2001
From: AJ Kelly <aj187@ajworld.net>
Date: Mon, 21 Feb 2011 03:57:23 -0600
Subject: [PATCH] commenting and such... things coming up

---
 src/CommonMetrics.cpp | 14 +++++++-------
 src/CommonMetrics.h   | 12 ++++++++++--
 2 files changed, 17 insertions(+), 9 deletions(-)

diff --git a/src/CommonMetrics.cpp b/src/CommonMetrics.cpp
index f7764b71ce..b981ae8d27 100644
--- a/src/CommonMetrics.cpp
+++ b/src/CommonMetrics.cpp
@@ -8,15 +8,16 @@
 #include "ProductInfo.h"
 #include "LuaManager.h"
 
-ThemeMetric<RString>			CommonMetrics::FIRST_ATTRACT_SCREEN		("Common","FirstAttractScreen");
-ThemeMetric<RString>			CommonMetrics::DEFAULT_MODIFIERS		("Common","DefaultModifiers" );
-LocalizedString				CommonMetrics::WINDOW_TITLE			("Common","WindowTitle");
+//ThemeMetric<RString>		CommonMetrics::OPERATOR_MENU_SCREEN		("Common","OperatorMenuScreen");
+ThemeMetric<RString>		CommonMetrics::FIRST_ATTRACT_SCREEN		("Common","FirstAttractScreen");
+ThemeMetric<RString>		CommonMetrics::DEFAULT_MODIFIERS		("Common","DefaultModifiers" );
+LocalizedString				CommonMetrics::WINDOW_TITLE				("Common","WindowTitle");
 ThemeMetric<int>			CommonMetrics::MAX_COURSE_ENTRIES_BEFORE_VARIOUS("Common","MaxCourseEntriesBeforeShowVarious");
 ThemeMetric<float>			CommonMetrics::TICK_EARLY_SECONDS		("ScreenGameplay","TickEarlySeconds");
-ThemeMetric<RString>			CommonMetrics::DEFAULT_NOTESKIN_NAME		("Common","DefaultNoteSkinName");
-ThemeMetricDifficultiesToShow		CommonMetrics::DIFFICULTIES_TO_SHOW		("Common","DifficultiesToShow");
+ThemeMetric<RString>		CommonMetrics::DEFAULT_NOTESKIN_NAME	("Common","DefaultNoteSkinName");
+ThemeMetricDifficultiesToShow	CommonMetrics::DIFFICULTIES_TO_SHOW		("Common","DifficultiesToShow");
 ThemeMetricCourseDifficultiesToShow	CommonMetrics::COURSE_DIFFICULTIES_TO_SHOW	("Common","CourseDifficultiesToShow");
-ThemeMetricStepsTypesToShow		CommonMetrics::STEPS_TYPES_TO_SHOW		("Common","StepsTypesToHide");	// This metric takes a list of StepsTypes to hide and returns a list of StepsTypes to show
+ThemeMetricStepsTypesToShow	CommonMetrics::STEPS_TYPES_TO_SHOW		("Common","StepsTypesToHide");
 ThemeMetric<bool>			CommonMetrics::AUTO_SET_STYLE			("Common","AutoSetStyle");
 ThemeMetric<int>			CommonMetrics::PERCENT_SCORE_DECIMAL_PLACES	("Common","PercentScoreDecimalPlaces");
 
@@ -79,7 +80,6 @@ void ThemeMetricCourseDifficultiesToShow::Read()
 }
 const vector<CourseDifficulty>& ThemeMetricCourseDifficultiesToShow::GetValue() const { return m_v; }
 
-
 static void RemoveStepsTypes( vector<StepsType>& inout, RString sStepsTypesToRemove )
 {
 	vector<RString> v;
diff --git a/src/CommonMetrics.h b/src/CommonMetrics.h
index fd426c321e..ca175ae449 100644
--- a/src/CommonMetrics.h
+++ b/src/CommonMetrics.h
@@ -45,9 +45,13 @@ private:
 /** @brief The common metrics that are used throughout. */
 namespace CommonMetrics
 {
+	/** @brief The first screen in the attract loop. */
 	extern ThemeMetric<RString>		FIRST_ATTRACT_SCREEN;
+	/** @brief The screen that appears when pressing the operator button. */
+	//extern ThemeMetric<RString>		OPERATOR_MENU_SCREEN;
+	/** @brief The default modifiers to apply. */
 	extern ThemeMetric<RString>		DEFAULT_MODIFIERS;
-	/** @brief the phrase that appears on the title bar. */
+	/** @brief The caption on the title bar. */
 	extern LocalizedString				WINDOW_TITLE;
 	/** @brief How many entries should be shown before showing "Various" instead. */
 	extern ThemeMetric<int>			MAX_COURSE_ENTRIES_BEFORE_VARIOUS;
@@ -59,7 +63,11 @@ namespace CommonMetrics
 	extern ThemeMetricDifficultiesToShow	DIFFICULTIES_TO_SHOW;
 	/** @brief Which course difficulties are to be shown? */
 	extern ThemeMetricCourseDifficultiesToShow	COURSE_DIFFICULTIES_TO_SHOW;
-	/** @brief Which step types are to be shown? */
+	/**
+	 * @brief Which step types are to be shown?
+	 *
+	 * This metric (StepsTypesToHide) takes a list of StepsTypes to hide and
+	 * returns a list of StepsTypes to show. */
 	extern ThemeMetricStepsTypesToShow	STEPS_TYPES_TO_SHOW;
 	/** @brief Does the player need to explicitly set a style? */
 	extern ThemeMetric<bool>			AUTO_SET_STYLE;