actions/itgmania212121
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

More doxygen.

Browse Source
This commit is contained in:
Jason Felds
2011-02-18 15:52:44 -05:00
parent 4a4b2ff440
commit 74e45aa432
2 changed files with 31 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/ScreenOptions.h
+10 -6
View File
@@ -1,4 +1,4 @@
/* ScreenOptions - A grid of options; the selected option is drawn with a highlight rectangle. */ /** @brief ScreenOptions - A grid of options; the selected option is drawn with a highlight rectangle. */
#ifndef SCREENOPTIONS_H #ifndef SCREENOPTIONS_H
#define SCREENOPTIONS_H #define SCREENOPTIONS_H
@@ -16,15 +16,17 @@ class OptionRowHandler;
AutoScreenMessage( SM_ExportOptions ) AutoScreenMessage( SM_ExportOptions )
/** @brief The list of input modes for the given row. */
enum InputMode enum InputMode
{ {
INPUTMODE_INDIVIDUAL, // each player controls their own cursor INPUTMODE_INDIVIDUAL, /**< each player controls their own cursor */
INPUTMODE_SHARE_CURSOR, // both players control the same cursor INPUTMODE_SHARE_CURSOR, /**< both players control the same cursor */
NUM_InputMode, NUM_InputMode, /**< The number of input modes available. */
InputMode_Invalid InputMode_Invalid
}; };
InputMode StringToInputMode( const RString& str ); InputMode StringToInputMode( const RString& str );
/** @brief A custom foreach loop for the player options for each player. */
#define FOREACH_OptionsPlayer( pn ) \ #define FOREACH_OptionsPlayer( pn ) \
for( PlayerNumber pn=GetNextHumanPlayer((PlayerNumber)-1); pn!=PLAYER_INVALID && (m_InputMode==INPUTMODE_INDIVIDUAL || pn==0); pn=GetNextHumanPlayer(pn) ) for( PlayerNumber pn=GetNextHumanPlayer((PlayerNumber)-1); pn!=PLAYER_INVALID && (m_InputMode==INPUTMODE_INDIVIDUAL || pn==0); pn=GetNextHumanPlayer(pn) )
@@ -149,8 +151,10 @@ protected: // derived classes need access to these
#endif #endif
/* /**
* (c) 2001-2004 Chris Danford, Glenn Maynard * @file
* @author Chris Danford, Glenn Maynard (c) 2001-2004
* @section LICENSE
* All rights reserved. * All rights reserved.
* *
* Permission is hereby granted, free of charge, to any person obtaining a * Permission is hereby granted, free of charge, to any person obtaining a
src/SpecialFiles.h
+16 -4
View File
@@ -3,10 +3,20 @@
#ifndef SpecialFiles_H #ifndef SpecialFiles_H
#define SpecialFiles_H #define SpecialFiles_H
/** @brief The listing of the special files and directories in use. */
namespace SpecialFiles namespace SpecialFiles
{ {
extern const RString USER_PACKAGES_DIR; // user packages should be a separate dir from system packages so that we can write to it (installing a package) /**
extern const RString PACKAGES_DIR; // system packages (not user packages) * @brief The user packages directory.
*
* This should be separate from system packages so that
* we can write to it (installing a package).
*/
extern const RString USER_PACKAGES_DIR;
/** @brief The system packages directory.
*
* This is not the user packages directory. */
extern const RString PACKAGES_DIR;
extern const RString KEYMAPS_PATH; extern const RString KEYMAPS_PATH;
extern const RString PREFERENCES_INI_PATH; extern const RString PREFERENCES_INI_PATH;
extern const RString THEMES_DIR; extern const RString THEMES_DIR;
@@ -25,8 +35,10 @@ namespace SpecialFiles
#endif #endif
/* /**
* (c) 2003-2005 Chris Danford * @file
* @author Chris Danford (c) 2003-2005
* @section LICENSE
* All rights reserved. * All rights reserved.
* *
* Permission is hereby granted, free of charge, to any person obtaining a * Permission is hereby granted, free of charge, to any person obtaining a