diff options
| author | Ben Boeckel <MathStuf@gmail.com> | 2008-11-25 18:50:52 -0500 |
|---|---|---|
| committer | Ben Boeckel <MathStuf@gmail.com> | 2008-11-25 18:50:52 -0500 |
| commit | 07e2bb39f2399c7a68c6cc8b511f0e5a2ac34565 (patch) | |
| tree | cc654b9e572ce5874f062fe3bab7369862dda433 | |
| parent | 0671d887f030aec3c62110ec2f4576d9df673874 (diff) | |
Badge documentation cleanup
| -rw-r--r-- | sigmod/Badge.h | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/sigmod/Badge.h b/sigmod/Badge.h index 509da0dd..d2727c58 100644 --- a/sigmod/Badge.h +++ b/sigmod/Badge.h @@ -37,8 +37,8 @@ class Sigmod; * \class Sigmod::Badge Badge.h sigmod/Badge.h * \brief Class describing a badge. * - * Badges are used to show a trainer's worthiness. Without them, team members that are too high leveled may not - * listen to its trainer. Badges may also boost stats. + * Badges are used to show a trainer's worthiness. Badges can raise the maximum level that a player + * can train a team member to without fear of it becoming unruly and ignoring commands. Badges may also boost stats. */ class SIGMOD_EXPORT Badge : public Object { @@ -59,7 +59,7 @@ class SIGMOD_EXPORT Badge : public Object */ Badge(const Sigmod* parent, const int id); /** - * Data copy constructor. Copies the data from \p badge and parents the new badge with \p parent and id \p id. + * Data copy constructor. Copies the data from \p badge as a child of \p parent and id \p id. * * \param badge The badge to copy the data from. * \param parent The parent of the badge. @@ -76,7 +76,7 @@ class SIGMOD_EXPORT Badge : public Object Badge(const QDomElement& xml, const Sigmod* parent, const int id = -1); /** - * Check to make sure the badge is valid. + * Check to make sure the badge's values are valid. */ void validate(); @@ -113,7 +113,7 @@ class SIGMOD_EXPORT Badge : public Object void setBadge(const int badge); /** * Set the maximum level at which team members of the player are guaranteed to obey the player. - * Above this level, team members may not obey its trainer. + * Above this level, team members may not necessarily obey its trainer. * * \param obey The maximum level that is guaranteed to obey the player once the badge is obtained. */ |
