Added Type documentation

2 files changed, 76 insertions, 2 deletions

diff --git a/sigmod/Type.cpp b/sigmod/Type.cpp
index b867a095..bbe7e950 100644
--- a/sigmod/Type.cpp
+++ b/sigmod/Type.cpp
@@ -1,5 +1,5 @@
 /*
- * Copyright 2007-2008 Ben Boeckel <MathStuf@gmail.com>
+ * Copyright 2007-2009 Ben Boeckel <MathStuf@gmail.com>
  * 
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -15,6 +15,10 @@
  * with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * \file sigmod/Type.cpp
+ */
+
 // Header include
 #include "Type.h"
 
diff --git a/sigmod/Type.h b/sigmod/Type.h
index 50cc4fbc..0744f288 100644
--- a/sigmod/Type.h
+++ b/sigmod/Type.h
@@ -1,5 +1,5 @@
 /*
- * Copyright 2007-2008 Ben Boeckel <MathStuf@gmail.com>
+ * Copyright 2007-2009 Ben Boeckel <MathStuf@gmail.com>
  * 
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -15,6 +15,10 @@
  * with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * \file sigmod/Type.h
+ */
+
 #ifndef SIGMOD_TYPE
 #define SIGMOD_TYPE
 
@@ -29,25 +33,91 @@ namespace Sigmod
 // Forward declarations
 class Sigmod;
 
+/**
+ * \class Sigmod::Type Type.h sigmod/Type.h
+ * \brief Types label species and moves.
+ * 
+ * Types allow for grouping of moves and species for effectiveness or
+ * other effects (e.g. a move using water may put out a fire).
+ */
 class SIGMOD_EXPORT Type : public Object
 {
     Q_OBJECT
     
     public:
+        /**
+         * Copy constructor.
+         * 
+         * \param type The type to copy.
+         */
         Type(const Type& type);
+        /**
+         * Create a new type belonging to \p parent and id \p id.
+         * 
+         * \param parent The parent of the type.
+         * \param id The id number for the type.
+         */
         Type(const Sigmod* parent, const int id);
+        /**
+         * Data copy constructor. Copies the data from \p type as a child of \p parent with id \p id.
+         * 
+         * \param type The type to copy the data from.
+         * \param parent The parent of the type.
+         * \param id The id number for the type.
+         */
         Type(const Type& type, const Sigmod* parent, const int id);
+        /**
+         * XML data constructor.
+         * 
+         * \param xml The XML structure to extract the data from.
+         * \param parent The parent of the type.
+         * \param id The id number for the type.
+         */
         Type(const QDomElement& xml, const Sigmod* parent, const int id = -1);
         
+        /**
+         * Check to make sure the type's values are valid.
+         */
         void validate();
         
+        /**
+         * Load data from XML.
+         * 
+         * \param xml The XML structure to extract data from.
+         */
         void load(const QDomElement& xml);
+        /**
+         * Get the data for the type in XML format.
+         * 
+         * \return The XML structure representing the type.
+         */
         QDomElement save() const;
         
+        /**
+         * The name of the type.
+         * 
+         * \param name The name of the type.
+         */
         void setName(const QString& name);
+        /**
+         * Sets the STAB (Same Type Attack Bnus) for the type. When a species that has this type
+         * uses a move of the same type, it gets a bonus multiplier.
+         * 
+         * \param stab the STAB of the type.
+         */
         void setStab(const Sigcore::Fraction& stab);
         
+        /**
+         * \sa setName
+         * 
+         * \return The name of the type.
+         */
         QString name() const;
+        /**
+         * \sa setStab
+         * 
+         * \return The STAB of the type.
+         */
         Sigcore::Fraction stab() const;
         
         bool nameCheck(const QString& name) const;