More docs, this time in the StepsUtil namespace.

2011-02-20 16:06:37 -05:00
parent 69b03d84a8
commit 0ee65df4c9
1 changed files with 24 additions and 0 deletions
@@ -115,9 +115,33 @@ public:
 /** @brief Utility functions for working with Steps. */
 namespace StepsUtil
 {
+	/**
+	 * @brief Retrieve all of the Steps that match the criteria.
+	 * @param soc the SongCriteria to look for.
+	 * @param stc the StepsCriteria to look for.
+	 * @param out the SongsAndSteps that match.
+	 */
 	void GetAllMatching( const SongCriteria &soc, const StepsCriteria &stc, vector<SongAndSteps> &out );	// look up in SONGMAN
+	/**
+	 * @brief Retrieve all of the Steps that match the criteria.
+	 * @param pSong the Song we're checking in.
+	 * @param stc the StepsCriteria to look for.
+	 * @param out the SongsAndSteps that match.
+	 */
 	void GetAllMatching( Song *pSong, const StepsCriteria &stc, vector<SongAndSteps> &out );
+	/**
+	 * @brief Is there a <a class="el" href="class_steps.html">Step</a>
+	 * that matches the criteria?
+	 * @param soc the SongCriteria to look for.
+	 * @param stc the StepsCriteria to look for.
+	 * @return true if we find a match, false otherwise. */
 	bool HasMatching( const SongCriteria &soc, const StepsCriteria &stc );
+	/**
+	 * @brief Is there a <a class="el" href="class_steps.html">Step</a>
+	 * that matches the criteria?
+	 * @param pSong the Song we're checking in.
+	 * @param stc the StepsCriteria to look for.
+	 * @return true if we find a match, false otherwise. */
 	bool HasMatching( const Song *pSong, const StepsCriteria &stc );

 	bool CompareNotesPointersByRadarValues(const Steps* pSteps1, const Steps* pSteps2);