[Widelands-cvs] widelands/src constants.h,1.14,1.15 sound_handler.cc,1.32,1.33

[Florian W. <be...@us...>]

Update of /cvsroot/widelands/widelands/src
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv13956/src

Modified Files:
	constants.h sound_handler.cc 
Log Message:
- source code documentation (by Philipp Niemann)


Index: constants.h
===================================================================
RCS file: /cvsroot/widelands/widelands/src/constants.h,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -d -r1.14 -r1.15
--- constants.h	22 Dec 2005 12:19:32 -0000	1.14
+++ constants.h	31 Dec 2005 12:20:08 -0000	1.15
@@ -20,49 +20,80 @@
 #ifndef CONSTANTS_H
 #define CONSTANTS_H
 
-// define current version
+/**
+ * \file constants.h
+ * \brief Global compile time configuration
+ *
+ * Changes have wide impact on recompile time.
+ * Lots more are scattered through header files
+ */
+
+/// Version mark for the build. Appears in title screen
 #define VERSION "cvs 24-12-2005 (inofficial)"
 
-// locale path: This would be needed to be changed by a packager
-// The default search path for locales is in the locale directory
-// but if widelands is installed, this changes to something like
-// /usr/locale/share/*. If so, change here
+/**
+ * locale path: This would be needed to be changed by a packager
+ *
+ * The default search path for locales is in the locale directory
+ * but if widelands is installed, this changes to something like
+ * /usr/locale/share/*. If so, change here
+ */
 #define LOCALE_PATH "locale"
 
-#define TEXTURE_W 64        // texture have a fixed size and are squares
-#define TEXTURE_H TEXTURE_W // TEXTURE_H is just defined for easier understandement of the code
+/* \name Textures
+ * textures have a fixed size and are squares
+ * TEXTURE_H is just defined for easier understandement of the code*/
+//@{
+#define TEXTURE_W 64
+#define TEXTURE_H TEXTURE_W
+//@}
 
-// The background colors are chosen to match the user interface 
-// backgrounds
+/// \name Fonts
+/// Font constants, defined including size
+//@{
 #define UI_FONT_BIG "FreeSerif.ttf", 22
-#define UI_FONT_ULTRASMALL "FreeSans.ttf", 10
 #define UI_FONT_SMALL "FreeSerif.ttf", 14
-#define UI_FONT_CLR_FG  RGBColor(255,255,0)
-#define UI_FONT_BIG_CLR UI_FONT_CLR_FG, RGBColor(107,87,55)
-#define UI_FONT_SMALL_CLR UI_FONT_CLR_FG, RGBColor(107,87,55)
+#define UI_FONT_ULTRASMALL "FreeSans.ttf", 10
+
 #define UI_FONT_TOOLTIP UI_FONT_SMALL
-#define UI_FONT_TOOLTIP_CLR RGBColor(100,100,255), RGBColor(230,200,50)
 #define PROSA_FONT       "FreeSerif.ttf", 18
-#define PROSA_FONT_CLR_FG   RGBColor(255,255,0)
 
+//@}
 
-/*
-================================================================================
+/// \name Font colors
+/// No background color
+//@{
 
-      COMPILE TIME CONFIGURATION
+/// Global UI font color
+#define UI_FONT_CLR_FG  RGBColor(255,255,0)
+/// Prosa font color
+#define PROSA_FONT_CLR_FG   RGBColor(255,255,0)
 
-================================================================================
-*/
+//@}
 
-// the actual game logic doesn't know about frames (it works with millisecond-precise
-// timing)
-// FRAME_LENGTH is just the default animation speed
+/** \name Text colors
+ * User interface text color constants
+ *
+ * Defined as "<fontcolor>, <background color>".
+ * The background colors are chosen to match the user interface
+ * backgrounds.
+ */
+//@{
+#define UI_FONT_BIG_CLR UI_FONT_CLR_FG, RGBColor(107,87,55)
+/// small is used for ultrasmall, too
+#define UI_FONT_SMALL_CLR UI_FONT_CLR_FG, RGBColor(107,87,55)
+#define UI_FONT_TOOLTIP_CLR RGBColor(100,100,255), RGBColor(230,200,50)
+//@}
+
+/// the actual game logic doesn't know about frames
+/// (it works with millisecond-precise timing)
+/// FRAME_LENGTH is just the default animation speed
 #define FRAME_LENGTH 250
 
-// Maxi numbers of players in a game
+/// Maxi numbers of players in a game
 #define MAX_PLAYERS		8
 
-// How often are statistics to be sampled
+/// How often are statistics to be sampled
 #define STATISTICS_SAMPLE_TIME 30000
 
 #endif

Index: sound_handler.cc
===================================================================
RCS file: /cvsroot/widelands/widelands/src/sound_handler.cc,v
retrieving revision 1.32
retrieving revision 1.33
diff -u -d -r1.32 -r1.33
--- sound_handler.cc	29 Dec 2005 20:27:31 -0000	1.32
+++ sound_handler.cc	31 Dec 2005 12:20:08 -0000	1.33
@@ -133,7 +133,7 @@
 
 //--------------------------------------------------------------------------------------
 
-/** Create an FXset and set it's \ref priority
+/** Create an FXset and set it's \ref m_priority
  * \param[in] prio	The desired priority (optional)*/
 FXset::FXset(Uint8 prio)
 {
@@ -156,7 +156,7 @@
 
 /** Append a sound effect to the end of the fxset
  * \param[in] fx	The sound fx to append
- * \param[in] prio	Set previous \ref priority to new value (optional)*/
+ * \param[in] prio	Set previous \ref m_priority to new value (optional)*/
 void FXset::add_fx(Mix_Chunk * fx, Uint8 prio)
 {
 	assert(fx);