Minor doc work.

This commit is contained in:
Jason Felds
2011-03-01 01:04:54 -05:00
parent 72703de9c6
commit 13ec2cc57b
4 changed files with 15 additions and 10 deletions
+1
View File
@@ -14,6 +14,7 @@ class AutoKeysounds
public: public:
void Load( PlayerNumber pn, const NoteData& ndAutoKeysoundsOnly ); void Load( PlayerNumber pn, const NoteData& ndAutoKeysoundsOnly );
void Update( float fDelta ); void Update( float fDelta );
/** @brief Finish loading the main sounds, and setup the auto keysounds if any. */
void FinishLoading(); void FinishLoading();
RageSound *GetSound() { return &m_sSound; } RageSound *GetSound() { return &m_sSound; }
RageSoundReader *GetSharedSound() { return m_pSharedSound; } RageSoundReader *GetSharedSound() { return m_pSharedSound; }
+4
View File
@@ -9,7 +9,11 @@
class OptionsCursor : public ActorFrame class OptionsCursor : public ActorFrame
{ {
public: public:
/** @brief Set up a default OptionsCursor. */
OptionsCursor(); OptionsCursor();
/**
* @brief Set up an OptionsCursor based on an existing copy.
* @param cpy the OptionsCursor we are copying. */
OptionsCursor( const OptionsCursor &cpy ); OptionsCursor( const OptionsCursor &cpy );
void Load( const RString &sMetricsGroup, bool bLoadCanGos ); void Load( const RString &sMetricsGroup, bool bLoadCanGos );
+5 -6
View File
@@ -1,8 +1,6 @@
/* ScreenMessage - Definition of common ScreenMessages and helpers. */
#ifndef ScreenMessage_H #ifndef ScreenMessage_H
#define ScreenMessage_H #define ScreenMessage_H
/** @brief Definition of common ScreenMessages and helpers. */
typedef RString ScreenMessage; typedef RString ScreenMessage;
extern const ScreenMessage SM_Invalid; extern const ScreenMessage SM_Invalid;
@@ -28,11 +26,12 @@ namespace ScreenMessageHelpers
#define AutoScreenMessage( x ) \ #define AutoScreenMessage( x ) \
const ScreenMessage x = ScreenMessageHelpers::ToScreenMessage( #x ) const ScreenMessage x = ScreenMessageHelpers::ToScreenMessage( #x )
#endif #endif
/* /**
* (c) 2003-2005 Chris Danford, Charles Lohr * @file
* @author Chris Danford, Charles Lohr (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
+5 -4
View File
@@ -1,4 +1,3 @@
/* ScreenPackagesSSC - parses JSON for downloadable content. */
#ifndef SCREEN_PACKAGES_SSC_H #ifndef SCREEN_PACKAGES_SSC_H
#define SCREEN_PACKAGES_SSC_H #define SCREEN_PACKAGES_SSC_H
@@ -8,7 +7,7 @@
#include "RageFileManager.h" #include "RageFileManager.h"
#include "RageFile.h" #include "RageFile.h"
#include "Sprite.h" #include "Sprite.h"
/** @brief Parses JSON for downloadable content. */
class ScreenPackagesSSC : public ScreenWithMenuElements class ScreenPackagesSSC : public ScreenWithMenuElements
{ {
public: public:
@@ -28,8 +27,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