[FIX] Started documenting Sigmod

[FIX] A few minor bugs

git-svn-id: https://pokegen.svn.sourceforge.net/svnroot/pokegen/trunk@272 6ecfd1a5-f3ed-3746-8530-beee90d26b22

1 files changed, 56 insertions, 2 deletions

diff --git a/sigmod/Badge.h b/sigmod/Badge.h
index debe7abe..e6a54ff0 100644
--- a/sigmod/Badge.h
+++ b/sigmod/Badge.h
@@ -36,7 +36,7 @@ class Sigmod;
  * \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. Some badges also boost stats (only with in-game battles).
+ * listen to its trainer. Badges may also boost stats.
  */
 class SIGMOD_EXPORT Badge : public Object
 {
@@ -59,7 +59,7 @@ class SIGMOD_EXPORT Badge : public Object
         /**
          * Data copy constructor. Copies the data from \p badge and parents the new badge with \p parent and id \p id.
          * 
-         * \param ability The badge to copy the data from.
+         * \param badge The badge to copy the data from.
          * \param parent The parent of the badge.
          * \param id The id number for the badge.
          */
@@ -91,16 +91,70 @@ class SIGMOD_EXPORT Badge : public Object
          */
         QDomElement save() const;
         
+        /**
+         * Sets the name of the badge to be used in the game.
+         * 
+         * \param name The name of the badge.
+         */
         void setName(const QString& name);
+        /**
+         * Set the \p id of the sprite that is to be used for the badge before it is obtained.
+         * 
+         * \param face The \p id of the sprite to be used before the badge is obtained.
+         */
         void setFace(const int face);
+        /**
+         * Set the \p id of the sprite that is to be used for the badge once it is obtained.
+         * 
+         * \param badge The \p id of the sprite to be used after the badge is obtained.
+         */
         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.
+         * 
+         * \param obey The maximum level that is guaranteed to obey the player once the badge is obtained.
+         */
         void setObey(const int obey);
+        /**
+         * Set a multiplier for a stat once the badge is obtained.
+         * 
+         * \param stat The stat to set the multiplier for.
+         * \param multiplier The multiplier for the stat once the badge is obtained.
+         */
         void setStat(const Stat stat, const Fraction& multiplier);
         
+        /**
+         * \sa setName
+         * 
+         * \return The name of the badge.
+         */
         QString name() const;
+        /**
+         * \sa setFace
+         * 
+         * \return The \p id of the sprite that represents the badge before it is obtained.
+         */
         int face() const;
+        /**
+         * \sa setBadge
+         * 
+         * \return The \p id of the sprite that represents the badge once it has been obtained.
+         */
         int badge() const;
+        /**
+         * \sa setObey
+         * 
+         * \return The maximum level that is guaranteed to obey the player once the badge is obtained.
+         */
         int obey() const;
+        /**
+         * \sa setStat
+         * 
+         * \param stat The stat to get the multiplier for.
+         * 
+         * \return The multiplier for the \p stat.
+         */
         Fraction stat(const Stat stat) const;
         
         Badge& operator=(const Badge& rhs);