From 2ab81841da2f7f0bea9b5a2c0918c54cceda0922 Mon Sep 17 00:00:00 2001 From: Jason Felds Date: Sun, 20 Feb 2011 15:14:28 -0500 Subject: [PATCH] Some more docs. --- src/StepsUtil.h | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/src/StepsUtil.h b/src/StepsUtil.h index 924d70f1a6..8ad3060699 100644 --- a/src/StepsUtil.h +++ b/src/StepsUtil.h @@ -73,9 +73,18 @@ public: class SongAndSteps { public: + /** @brief the Song we're using. */ Song *pSong; + /** @brief the Steps we're using. */ Steps *pSteps; + /** @brief Set up a blank Song and + SongAndSteps() : pSong(NULL), pSteps(NULL) { } + /** + * @brief Set up the specified Song and + * Step. + * @param pSong_ the new Song. + * @param pSteps_ the new Step. */ SongAndSteps( Song *pSong_, Steps *pSteps_ ) : pSong(pSong_), pSteps(pSteps_) { } bool operator==( const SongAndSteps& other ) const { return pSong==other.pSong && pSteps==other.pSteps; } bool operator<( const SongAndSteps& other ) const { if( pSong!=other.pSong ) return pSong