Added Store documentation

2 files changed, 79 insertions, 0 deletions

diff --git a/sigmod/Store.cpp b/sigmod/Store.cpp
index 1e6a353e..58f114f7 100644
--- a/sigmod/Store.cpp
+++ b/sigmod/Store.cpp
@@ -15,6 +15,10 @@
  * with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * \file sigmod/Store.cpp
+ */
+
 // Header include
 #include "Store.h"
 
diff --git a/sigmod/Store.h b/sigmod/Store.h
index 63209eaf..1097119c 100644
--- a/sigmod/Store.h
+++ b/sigmod/Store.h
@@ -15,6 +15,10 @@
  * with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * \file sigmod/Store.h
+ */
+
 #ifndef SIGMOD_STORE
 #define SIGMOD_STORE
 
@@ -29,26 +33,97 @@ namespace Sigmod
 // Forward declarations
 class Sigmod;
 
+/**
+ * \class Sigmod::Store Store.h sigmod/Store.h
+ * \brief Class describing a store.
+ * 
+ * Stores are places where items can be purchased from.
+ */
 class SIGMOD_EXPORT Store : public Object
 {
     Q_OBJECT
     
     public:
+        /**
+         * Copy constructor.
+         * 
+         * \param store The store to copy.
+         */
         Store(const Store& store);
+        /**
+         * Create a new store belonging to \p parent and id \p id.
+         * 
+         * \param parent The parent of the store.
+         * \param id The id number for the store.
+         */
         Store(const Sigmod* parent, const int id);
+        /**
+         * Data copy constructor. Copies the data from \p store as a child of \p parent with id \p id.
+         * 
+         * \param store The store to copy the data from.
+         * \param parent The parent of the store.
+         * \param id The id number for the store.
+         */
         Store(const Store& store, 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 store.
+         * \param id The id number for the store.
+         */
         Store(const QDomElement& xml, const Sigmod* parent, const int id = -1);
         
+        /**
+         * Check to make sure the store'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 store in XML format.
+         * 
+         * \return The XML structure representing the store.
+         */
         QDomElement save() const;
         
+        /**
+         * Sets the name of the store. It is only used internally.
+         * 
+         * \param name The name of the store.
+         */
         void setName(const QString& name);
+        /**
+         * Sets the state of an item in the store's item list.
+         * 
+         * \param item The id of the item to set.
+         * \param state If \p true, the item can be bought, otherwise, disable it.
+         */
         void setItem(const int item, const bool state);
         
+        /**
+         * \sa setName
+         * 
+         * \return The name of the store.
+         */
         QString name() const;
+        /**
+         * \sa setItem
+         * 
+         * \param item The id of the item to check for.
+         * \return Whether the item can be cought at the store or not.
+         */
         bool item(const int item) const;
+        /**
+         * \sa setItem
+         * 
+         * \return The list of ids of items that can be cought at the store.
+         */
         QList<int> item() const;
         
         bool nameCheck(const QString& name) const;