Last batch of doxygen for a bit.

This commit is contained in:
Jason Felds
2011-02-25 12:33:43 -05:00
parent 40f7d8ef7a
commit 054ead23d6
11 changed files with 56 additions and 54 deletions
+5 -5
View File
@@ -1,5 +1,3 @@
/* MusicWheelItem - An item on the MusicWheel. */
#ifndef MUSIC_WHEEL_ITEM_H #ifndef MUSIC_WHEEL_ITEM_H
#define MUSIC_WHEEL_ITEM_H #define MUSIC_WHEEL_ITEM_H
@@ -33,7 +31,7 @@ enum MusicWheelItemType
MusicWheelItemType_Invalid, MusicWheelItemType_Invalid,
}; };
const RString& MusicWheelItemTypeToString( MusicWheelItemType i ); const RString& MusicWheelItemTypeToString( MusicWheelItemType i );
/** @brief An item on the MusicWheel. */
class MusicWheelItem : public WheelItemBase class MusicWheelItem : public WheelItemBase
{ {
public: public:
@@ -80,8 +78,10 @@ struct MusicWheelItemData : public WheelItemBaseData
#endif #endif
/* /**
* (c) 2001-2004 Chris Danford, Chris Gomez, Glenn Maynard * @file
* @author Chris Danford, Chris Gomez, 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
+5 -5
View File
@@ -1,5 +1,3 @@
/* PaneDisplay - An Actor that displays song information. */
#ifndef PANE_DISPLAY_H #ifndef PANE_DISPLAY_H
#define PANE_DISPLAY_H #define PANE_DISPLAY_H
@@ -30,7 +28,7 @@ enum PaneCategory
NUM_PaneCategory, NUM_PaneCategory,
PaneCategory_Invalid, PaneCategory_Invalid,
}; };
/** @brief An Actor that displays Song information. */
class PaneDisplay: public ActorFrame class PaneDisplay: public ActorFrame
{ {
public: public:
@@ -60,8 +58,10 @@ private:
#endif #endif
/* /**
* (c) 2003 Glenn Maynard * @file
* @author Glenn Maynard (c) 2003
* @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
+10 -6
View File
@@ -18,11 +18,12 @@ enum MusicWheelUsesSections
NUM_MusicWheelUsesSections, NUM_MusicWheelUsesSections,
MusicWheelUsesSections_Invalid MusicWheelUsesSections_Invalid
}; };
/** @brief The options for allowing the W1 timing. */
enum AllowW1 enum AllowW1
{ {
ALLOW_W1_NEVER, ALLOW_W1_NEVER, /**< The W1 timing is not used. */
ALLOW_W1_COURSES_ONLY, ALLOW_W1_COURSES_ONLY, /**< The W1 timing is used for courses only. */
ALLOW_W1_EVERYWHERE, ALLOW_W1_EVERYWHERE, /**< The W1 timing is used for all modes. */
NUM_AllowW1, NUM_AllowW1,
AllowW1_Invalid AllowW1_Invalid
}; };
@@ -290,7 +291,8 @@ public:
Preference<RString> m_sMachineName; Preference<RString> m_sMachineName;
Preference<RString> m_sCoursesToShowRanking; Preference<RString> m_sCoursesToShowRanking;
Preference<bool> m_bQuirksMode; // enable quirky behavior desired by users of microsoft stepmania explorer 6.9 /** @brief Enable some quirky behavior used by some older versions of StepMania. */
Preference<bool> m_bQuirksMode;
// Preference<RString> m_sDefaultFailType; // XXX: Fix fail bug? // Preference<RString> m_sDefaultFailType; // XXX: Fix fail bug?
// Debug: // Debug:
@@ -335,8 +337,10 @@ extern PrefsManager* PREFSMAN; // global and accessable from anywhere in our pro
#endif #endif
/* /**
* (c) 2001-2004 Chris Danford, Chris Gomez * @file
* @author Chris Danford, Chris Gomez (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
+1 -3
View File
@@ -1,11 +1,9 @@
/* RageFileDriverZip - A read-only file driver for ZIPs. */
#ifndef RAGE_FILE_DRIVER_ZIP_H #ifndef RAGE_FILE_DRIVER_ZIP_H
#define RAGE_FILE_DRIVER_ZIP_H #define RAGE_FILE_DRIVER_ZIP_H
#include "RageFileDriver.h" #include "RageFileDriver.h"
#include "RageThreads.h" #include "RageThreads.h"
/** @brief A read-only file driver for ZIPs. */
class RageFileDriverZip: public RageFileDriver class RageFileDriverZip: public RageFileDriver
{ {
public: public:
+6 -6
View File
@@ -1,5 +1,3 @@
/* FilenameDB - A container for a file listing. */
#ifndef RAGE_UTIL_FILEDB #ifndef RAGE_UTIL_FILEDB
#define RAGE_UTIL_FILEDB #define RAGE_UTIL_FILEDB
@@ -54,7 +52,7 @@ struct File
} }
}; };
/* This represents a directory. */ /** @brief This represents a directory. */
struct FileSet struct FileSet
{ {
set<File> files; set<File> files;
@@ -78,7 +76,7 @@ struct FileSet
int GetFileSize( const RString &sPath ) const; int GetFileSize( const RString &sPath ) const;
int GetFileHash( const RString &sPath ) const; int GetFileHash( const RString &sPath ) const;
}; };
/** @brief A container for a file listing. */
class FilenameDB class FilenameDB
{ {
public: public:
@@ -141,8 +139,10 @@ public:
#endif #endif
/* /**
* Copyright (c) 2003-2004 Glenn Maynard * @file
* @author Glenn Maynard (c) 2003-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
+5 -5
View File
@@ -1,12 +1,10 @@
/* ScreenEnding - Ending screen that shows stats. */
#ifndef SCREEN_ENDING_H #ifndef SCREEN_ENDING_H
#define SCREEN_ENDING_H #define SCREEN_ENDING_H
#include "BitmapText.h" #include "BitmapText.h"
#include "ScreenAttract.h" #include "ScreenAttract.h"
#include "Sprite.h" #include "Sprite.h"
/** @brief Ending screen that shows stats. */
class ScreenEnding : public ScreenAttract class ScreenEnding : public ScreenAttract
{ {
public: public:
@@ -20,8 +18,10 @@ private:
#endif #endif
/* /**
* (c) 2004 Chris Danford * @file
* @author Chris Danford (c) 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
+6 -6
View File
@@ -1,5 +1,3 @@
/* ScreenNameEntryTraditional - Enter a name for a new high score. */
#ifndef SCREEN_NAME_ENTRY_TRADITIONAL_H #ifndef SCREEN_NAME_ENTRY_TRADITIONAL_H
#define SCREEN_NAME_ENTRY_TRADITIONAL_H #define SCREEN_NAME_ENTRY_TRADITIONAL_H
@@ -7,7 +5,7 @@
#include "ThemeMetric.h" #include "ThemeMetric.h"
#include "LocalizedString.h" #include "LocalizedString.h"
#include "InputQueue.h" #include "InputQueue.h"
/** @brief Enter a name for a new high score. */
class ScreenNameEntryTraditional: public ScreenWithMenuElements class ScreenNameEntryTraditional: public ScreenWithMenuElements
{ {
public: public:
@@ -28,7 +26,7 @@ public:
bool Finish( PlayerNumber pn ); bool Finish( PlayerNumber pn );
void UpdateSelectionText( PlayerNumber pn ); void UpdateSelectionText( PlayerNumber pn );
void SelectChar( PlayerNumber pn, const RString &sKey ); void SelectChar( PlayerNumber pn, const RString &sKey );
/** @brief How long can the name be for ranking purposes? */
ThemeMetric<int> MAX_RANKING_NAME_LENGTH; ThemeMetric<int> MAX_RANKING_NAME_LENGTH;
wstring m_sSelection[NUM_PLAYERS]; wstring m_sSelection[NUM_PLAYERS];
@@ -38,8 +36,10 @@ public:
#endif #endif
/* /**
* (c) 2001-2007 Glenn Maynard, Chris Danford * @file
* @author Glenn Maynard, Chris Danford (c) 2001-2007
* @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
+1 -3
View File
@@ -1,12 +1,10 @@
/** @brief ScreenSelect - Base class for Style, Difficulty, and Mode selection screens. */
#ifndef SCREEN_SELECT_H #ifndef SCREEN_SELECT_H
#define SCREEN_SELECT_H #define SCREEN_SELECT_H
#include "ScreenWithMenuElements.h" #include "ScreenWithMenuElements.h"
#include "GameCommand.h" #include "GameCommand.h"
#include "ThemeMetric.h" #include "ThemeMetric.h"
/** @brief Base class for Style, Difficulty, and Mode selection screens. */
class ScreenSelect : public ScreenWithMenuElements class ScreenSelect : public ScreenWithMenuElements
{ {
public: public:
+5 -5
View File
@@ -1,12 +1,10 @@
/* ScreenSyncOverlay - credits and statistics drawn on top of everything else. */
#ifndef ScreenSyncOverlay_H #ifndef ScreenSyncOverlay_H
#define ScreenSyncOverlay_H #define ScreenSyncOverlay_H
#include "Screen.h" #include "Screen.h"
#include "BitmapText.h" #include "BitmapText.h"
#include "Quad.h" #include "Quad.h"
/** @brief Credits and statistics drawn on top of everything else. */
class ScreenSyncOverlay : public Screen class ScreenSyncOverlay : public Screen
{ {
public: public:
@@ -31,8 +29,10 @@ private:
#endif #endif
/* /**
* (c) 2001-2005 Chris Danford * @file
* @author Chris Danford (c) 2001-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
+7 -6
View File
@@ -1,5 +1,3 @@
/* SnapDisplay - Graphics on ends of receptors on Edit screen that show the current snap type. */
#ifndef SNAPDISPLAY_H #ifndef SNAPDISPLAY_H
#define SNAPDISPLAY_H #define SNAPDISPLAY_H
@@ -12,7 +10,7 @@
* Convert m_sprIndicators to AutoActors * Convert m_sprIndicators to AutoActors
* ThemeMetric for deciding to load one or two indicators? -aj * ThemeMetric for deciding to load one or two indicators? -aj
*/ */
/** @brief Graphics on ends of receptors on Edit screen that show the current snap type. */
class SnapDisplay : public ActorFrame class SnapDisplay : public ActorFrame
{ {
public: public:
@@ -30,15 +28,18 @@ protected:
void SnapModeChanged(); void SnapModeChanged();
NoteType m_NoteType; // snap to this note type /** @brief the NoteType to snap to. */
NoteType m_NoteType;
Sprite m_sprIndicators[2]; // left and right side Sprite m_sprIndicators[2]; // left and right side
}; };
#endif #endif
/* /**
* (c) 2001-2002 Chris Danford * @file
* @author Chris Danford (c) 2001-2002
* @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
+5 -4
View File
@@ -1,9 +1,8 @@
/* LoadingWindow - opens and displays the loading banner. */
#ifndef LOADING_WINDOW_H #ifndef LOADING_WINDOW_H
#define LOADING_WINDOW_H #define LOADING_WINDOW_H
struct RageSurface; struct RageSurface;
/** @brief Opens and displays the loading banner. */
class LoadingWindow class LoadingWindow
{ {
public: public:
@@ -19,8 +18,10 @@ public:
#endif #endif
/* /**
* (c) 2002-2004 Glenn Maynard * @file
* @author Glenn Maynard (c) 2002-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