More doxygen.

This commit is contained in:
Jason Felds
2011-02-25 01:57:34 -05:00
parent 58e4e13025
commit f9371eb415
3 changed files with 26 additions and 13 deletions
+6 -5
View File
@@ -1,12 +1,10 @@
/* DualScrollBar - a scrollbar with two independent thumbs. */
#ifndef DUAL_SCROLLBAR_H
#define DUAL_SCROLLBAR_H
#include "ActorFrame.h"
#include "AutoActor.h"
#include "PlayerNumber.h"
/** @brief A scrollbar with two independent thumbs. */
class DualScrollBar: public ActorFrame
{
public:
@@ -19,6 +17,7 @@ public:
void EnablePlayer( PlayerNumber pn, bool on );
private:
/** @brief The height of the scrollbar. */
float m_fBarHeight;
float m_fBarTime;
@@ -28,8 +27,10 @@ private:
#endif
/*
* (c) 2001-2004 Glenn Maynard, Chris Danford
/**
* @file
* @author Glenn Maynard, Chris Danford (c) 2001-2004
* @section LICENSE
* All rights reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a
+15 -7
View File
@@ -1,5 +1,3 @@
/* Game - Holds information about a particular style of a game (e.g. "single", "double"). */
#ifndef GAMEDEF_H
#define GAMEDEF_H
@@ -27,21 +25,29 @@ class Style;
// have the flag FLAG_SECONDARY_MENU_*, they will function as MenuLeft and
// MenuRight as long as "MenuLeft (optional)" and "MenuRight (optional)" are not mapped.
/** @brief Holds information about a particular style of a game (e.g. "single", "double"). */
class Game
{
public:
const char * m_szName;
const Style * const* m_apStyles;
bool m_bCountNotesSeparately; // Count multiple notes in a row as separate notes or as one note
bool m_bAllowHopos; // allow Hammer-ons and Pull-offs? Only useful for guitar type input.
/** @brief Do we count multiple notes in a row as separate notes, or as one note? */
bool m_bCountNotesSeparately;
/** @brief Do we allow for hammer-ons and pull-offs?
*
* This is right now only useful for guitar type input. */
bool m_bAllowHopos;
InputScheme m_InputScheme;
struct PerButtonInfo
{
GameButtonType m_gbt;
};
// Data for each Game-specific GameButton. This starts at GAME_BUTTON_NEXT.
/**
* @brief Data for each Game-specific GameButton.
*
* This starts at GAME_BUTTON_NEXT. */
PerButtonInfo m_PerButtonInfo[NUM_GameButton];
const PerButtonInfo *GetPerButtonInfo( GameButton gb ) const;
@@ -58,8 +64,10 @@ public:
#endif
/*
* (c) 2001-2002 Chris Danford
/**
* @file
* @author Chris Danford (c) 2001-2002
* @section LICENSE
* All rights reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a
+5 -1
View File
@@ -73,7 +73,11 @@ public:
SortOrder m_SortOrder;
RString m_sSoundPath; // "" for no sound
vector<RString> m_vsScreensToPrepare;
int m_iWeightPounds; // -1 == none specified
/**
* @brief What is the player's weight in pounds?
*
* If this value is -1, then no weight was specified. */
int m_iWeightPounds;
int m_iGoalCalories; // -1 == none specified
GoalType m_GoalType;
RString m_sProfileID;