More doxygen.

Learning how to manually link to other classes.
We may have to take advantage of this to keep
proper english.
This commit is contained in:
Jason Felds
2011-02-19 11:35:15 -05:00
parent 7666a68151
commit ffebd5010f
4 changed files with 64 additions and 16 deletions
+10
View File
@@ -10,9 +10,19 @@ class Trail;
class Course;
class XNode;
/** @brief Utility functions for dealing with the Trail. */
namespace TrailUtil
{
/**
* @brief Retrieve the number of
* <a class="el" href="class_song.html">Songs</a> in the Trail.
* @param pTrail the Trail itself.
* @return the number of <a class="el" href="class_song.html">Songs</a>. */
int GetNumSongs( const Trail *pTrail );
/**
* @brief Retrieve how long the Trail will last in seconds.
* @param pTrail the Trail itself.
* @return the total run time of the Trail. */
float GetTotalSeconds( const Trail *pTrail );
};