doxygen comments

[aspt.git] / main.cc

diff --git a/main.cc b/main.cc
index f112a34..632b23c 100644 (file)
--- a/main.cc
+++ b/main.cc
@@ -8,15 +8,21 @@ http://creativecommons.org/licenses/by-nc-nd/2.5/legalcode
 
 void parse(const QString &data);
 
-int playerCnt;
-Player pls[45];
-int staffCnt;
-StaffMemberStruct staff[7];
-StadiumStruct stadium;
-ClubStruct club;
+int playerCnt;         ///< number of players parsed
+Player pls[45];                ///< parsed players array
+int staffCnt;          ///< number of staff parsed
+StaffMemberStruct staff[7];            ///< parsed staff array
+StadiumStruct stadium;         ///< parsed stadium
+ClubStruct club;               ///< parsed club
 int dataParsed[20][4];
 int globSlot, curSlot, curSeason;
 
+/**
+ * \brief Function parsing input XML.
+ *
+ * Parse players, staff, stadium etc. info from soccerproject XML.
+ * \param[in] data path to input xml.
+ */
 void parse(const QString &data) {
        QDomDocument doc("spdt");
        QFile file( data );
@@ -717,6 +723,13 @@ void parse(const QString &data) {
        }
 }
 
+/**
+ * \brief Function partially parsing input XML.
+ *
+ * Parse only information about current season.
+ * Used to assigning season to input xml on the fly.
+ * \param[in] data path to input xml.
+ */
 void quickparse(const QString &data) {
        QDomDocument doc("spdt");
        QFile file( data );