diff --git a/src/Song.h b/src/Song.h index 215e583d64..7def778ee5 100644 --- a/src/Song.h +++ b/src/Song.h @@ -62,12 +62,12 @@ class Song public: void SetSongDir( const RString sDir ) { m_sSongDir = sDir; } - /** @brief When should this song should be displayed in the music wheel? */ + /** @brief When should this song be displayed in the music wheel? */ enum SelectionDisplay { SHOW_ALWAYS, /**< always show on the wheel. */ SHOW_NEVER /**< never show on the wheel (unless song hiding is turned off). */ - } m_SelectionDisplay; + } /** @brief When should this song be displayed in the music wheel? */ m_SelectionDisplay; Song(); ~Song(); @@ -141,14 +141,23 @@ public: * this will point to a generated .SSC filename. */ RString m_sSongFileName; + /** @brief The group this Song is in. */ RString m_sGroupName; ProfileSlot m_LoadedFromProfile; // ProfileSlot_Invalid if not loaded from a profile + /** @brief Is the song file itself a symlink to another file? */ bool m_bIsSymLink; bool m_bEnabled; - RString m_sMainTitle, m_sSubTitle, m_sArtist; - RString m_sMainTitleTranslit, m_sSubTitleTranslit, m_sArtistTranslit; + /** @brief The title of the Song. */ + RString m_sMainTitle; + /** @brief The subtitle of the Song, if it exists. */ + RString m_sSubTitle; + /** @brief The artist of the Song, if it exists. */ + RString m_sArtist; + RString m_sMainTitleTranslit; + RString m_sSubTitleTranslit; + RString m_sArtistTranslit; /* If PREFSMAN->m_bShowNative is off, these are the same as GetTranslit* * below. Otherwise, they return the main titles. */ @@ -167,7 +176,7 @@ public: /** @brief The version of the song/file. */ float m_fVersion; - + /** @brief The genre of the song/file. */ RString m_sGenre; /** @@ -216,7 +225,13 @@ public: bool HasMusic() const; bool HasInstrumentTrack( InstrumentTrack it ) const; + /** + * @brief Does this song have a banner? + * @return true if it does, false otherwise. */ bool HasBanner() const; + /** + * @brief Does this song have a background? + * @return true if it does, false otherwise. */ bool HasBackground() const; //bool HasJacket() const; //bool HasCDImage() const; @@ -229,6 +244,7 @@ public: bool Matches(RString sGroup, RString sSong) const; + /** @brief The Song's TimingData. */ TimingData m_Timing; typedef vector VBackgroundChange; diff --git a/src/SoundEffectControl.h b/src/SoundEffectControl.h index 8bbd9e678f..02deb6d156 100644 --- a/src/SoundEffectControl.h +++ b/src/SoundEffectControl.h @@ -1,5 +1,3 @@ -/* SoundEffectControl - Control a sound property through user input. */ - #ifndef SOUND_EFFECT_CONTROL_H #define SOUND_EFFECT_CONTROL_H @@ -8,7 +6,7 @@ class RageSoundReader; class PlayerState; class NoteData; - +/** @brief Control a sound property through user input. */ class SoundEffectControl { public: @@ -42,8 +40,10 @@ private: #endif -/* - * (c) 2006-2007 Glenn Maynard +/** + * @file + * @author Glenn Maynard (c) 2006-2007 + * @section LICENSE * All rights reserved. * * Permission is hereby granted, free of charge, to any person obtaining a diff --git a/src/WheelNotifyIcon.h b/src/WheelNotifyIcon.h index 8a8f6608d3..63f5802922 100644 --- a/src/WheelNotifyIcon.h +++ b/src/WheelNotifyIcon.h @@ -1,10 +1,8 @@ -/* WheelNotifyIcon - A little graphic to the side of the song's text banner in the MusicWheel. */ - #ifndef WHEEL_NOTIFY_ICON_H #define WHEEL_NOTIFY_ICON_H #include "Sprite.h" - +/** @brief A little graphic to the side of the song's text banner in the MusicWheel. */ class WheelNotifyIcon : public Sprite { public: @@ -25,15 +23,29 @@ public: virtual bool EarlyAbortDraw() const; protected: - enum Icons { training=0, best1, best2, best3, edits, long_ver, marathon, empty }; + /** @brief What types of icons are available for the Song? */ + enum Icons + { + training=0, /**< This song is used for training new Players. */ + best1, /**< This is the most popular Song to play. */ + best2, /**< This is the second most popular Song to play. */ + best3, /**< This is the third most popular Song to play. */ + edits, /**< This Song has edits available. */ + long_ver, /**< This Song is a long version, and will take 2 Songs in most modes. */ + marathon, /**< This Song is a marathon version, and will take 3 Songs in most modes. */ + empty /**< There is no icon meant for this Song. */ + }; + /** @brief the list of Icons to show. */ vector m_vIconsToShow; }; #endif -/* - * (c) 2001-2004 Chris Danford +/** + * @file + * @author Chris Danford (c) 2001-2004 + * @section LICENSE * All rights reserved. * * Permission is hereby granted, free of charge, to any person obtaining a