doxygen comments
authorJan Cermak <me@johniez.cz>
Sun, 8 Mar 2009 14:51:52 +0000 (15:51 +0100)
committerJan Cermak <me@johniez.cz>
Sun, 8 Mar 2009 14:51:52 +0000 (15:51 +0100)
25 files changed:
abouttab.cc
abouttab.h
clubtab.cc
clubtab.h
configtab.cc
configtab.h
loadtab.cc
loadtab.h
main.cc
mainwindow.cc
mainwindow.h
performance.cc
performance.h
playerdetail.cc
playerdetail.h
playertab.cc
playertab.h
proxyset.cc
proxyset.h
stadiumtab.cc
stadiumtab.h
staffmember.cc
staffmember.h
stafftab.cc
stafftab.h

index 7e7d500a6d9e1bd20ed5210d63d250facfae25f1..d4be83e4776c811bba4948abd6ccb68e4ef60a21 100644 (file)
@@ -6,15 +6,26 @@ http://creativecommons.org/licenses/by-nc-nd/2.5/legalcode
 
 #include "abouttab.h"
 
+/**
+ * \brief About Tab constructor.
+ */
 AboutTab::AboutTab(QWidget *parent) : QWidget(parent) {
        init();
 }
 
+/**
+ * \brief About Tab destructor.
+ */
 AboutTab::~AboutTab() {
        delete label;
        delete mainLayout;
 }
 
+/**
+ * \brief About Tab initializer.
+ *
+ * Set some text into about tab.
+ */
 void AboutTab::init() {
        mainLayout = new QVBoxLayout;
        QString text;
index fb2e7c7511c8dc8e29045c0ddbd1fa2892b653a0..ee6245a586d866a142b95784e8ec0e42803ed3ca 100644 (file)
@@ -11,6 +11,9 @@ http://creativecommons.org/licenses/by-nc-nd/2.5/legalcode
 #include <QVBoxLayout>
 #include <QLabel>
 
+/**
+ * \brief About Tab widget.
+ */
 class AboutTab: public QWidget {
        Q_OBJECT
        QVBoxLayout *mainLayout;
index 8418ee99e80d7e923789e87bfb5caf011e79a820..887076ec419ae30c26595749672d0a1a33b0da3a 100644 (file)
@@ -6,15 +6,26 @@ http://creativecommons.org/licenses/by-nc-nd/2.5/legalcode
 
 #include "clubtab.h"
 
+/**
+ * Club Tab constructor.
+ */
 ClubTab::ClubTab(QWidget *parent) : QWidget(parent) {
        init();
 }
 
+/**
+ * Club Tab destructor.
+ */
 ClubTab::~ClubTab() {
        delete label;
        delete mainLayout;
 }
 
+/**
+ * \brief Club Tab initializer.
+ *
+ * Set text into Club Tab.
+ */
 void ClubTab::init() {
        mainLayout = new QVBoxLayout;
        QString text;
@@ -59,10 +70,20 @@ void ClubTab::init() {
        setLayout(mainLayout);
 }
 
+/**
+ * \brief Slot assigned to data change action.
+ * 
+ * Rebuild UI with new data.
+ */
 void ClubTab::dataChanged() {
        rebuildUI();
 }
 
+/**
+ * \brief Redraw UI with new data.
+ *
+ * Destroy old widget and initialize new one..
+ */
 void ClubTab::rebuildUI() {
        label->clear();
        delete mainLayout;
index 54e0b1a9c3d0a36ca42f02e8b9380766a897a89c..2b537c41427535585757db7e740a4774eb152f8e 100644 (file)
--- a/clubtab.h
+++ b/clubtab.h
@@ -12,6 +12,7 @@ http://creativecommons.org/licenses/by-nc-nd/2.5/legalcode
 #include <QPushButton>
 #include <QLabel>
 
+/// Struct with club information.
 struct ClubStruct {
        QString name, budget, rat, fndd, spirit, curpos, curdiv, totgmade, totgrecv, curgmade, curgrecv, curlgmade, curlgrecv, tothgames, totwins, totdraws, totlosts, curhgames, curwins, curdraws, curlosts, curlwins, curldraws, curllosts, totmaxatt, curmaxatt, totavgatt, curavgatt, form, for_a, tactic_a, attstyle_a, agr_a, cap_a;
        bool incup;
@@ -20,6 +21,7 @@ struct ClubStruct {
 extern void parse(const QString &);
 extern ClubStruct club;
 
+/// Club Tab widget.
 class ClubTab: public QWidget {
        Q_OBJECT
        QVBoxLayout *mainLayout;
index 841dd046c465f400efc786ee194ac5ba3d4e8bb5..fa2b24cd1a534980b96c9d9f3f1025546983c278 100755 (executable)
@@ -6,6 +6,9 @@ http://creativecommons.org/licenses/by-nc-nd/2.5/legalcode
 
 #include "configtab.h"
 
+/**
+ * \brief Config Tab constructor.
+ */
 ConfigTab::ConfigTab(QWidget *parent): QWidget(parent) {
        file = 0;
        http = new QHttp;
@@ -76,6 +79,9 @@ ConfigTab::ConfigTab(QWidget *parent): QWidget(parent) {
        setLayout(mainLayout);
 }
 
+/**
+ * \brief Config Tab destructor.
+ */
 ConfigTab::~ConfigTab() {
        if(file) delete file;
        delete http;
@@ -100,14 +106,24 @@ ConfigTab::~ConfigTab() {
        delete mainLayout;
 }
 
+/**
+ * \brief Slot assigned to language change action.
+ * \param langId language ID.
+ */
 void ConfigTab::changeLang(int langId) {
        langToSave = langId;
 }
 
+/**
+ * \brief Slot assigned to proxy settings opening action.
+ */
 void ConfigTab::openProxy() {
        proxyWin = new ProxySet();
 }
 
+/**
+ * \brief Slot assigned to save button click.
+ */
 void ConfigTab::saveSettings() {
        const char* langs[5] = {"en", "cs", "ro", "pl", "lt"};
        QSettings settings("config/global.ini", QSettings::IniFormat);
@@ -117,6 +133,9 @@ void ConfigTab::saveSettings() {
        }
 }
 
+/**
+ * \brief Slot assigned to download button click.
+ */
 void ConfigTab::downloadLatest() {
        QSettings settings("config/global.ini", QSettings::IniFormat);
        useProxy = settings.value("Network/proxyUsed", 0).toInt();
@@ -134,6 +153,9 @@ void ConfigTab::downloadLatest() {
        settings.sync();
 }
 
+/**
+ * \brief Slot assigned to download finished action.
+ */
 void ConfigTab::httpRequestFinished(int requestId, bool error) {
        if (requestId != httpId) return;
 
@@ -171,6 +193,10 @@ void ConfigTab::httpRequestFinished(int requestId, bool error) {
        file = 0;
 }
 
+/**
+ * \brief Slot assigned to QHttp response action.
+ * \param responseHeader QHttp response.
+ */
 void ConfigTab::readResponseHeader(const QHttpResponseHeader &responseHeader) {
        if (responseHeader.statusCode() != 200) {
                QMessageBox::information(this, tr("HTTP"), tr("Download failed: %1.").arg(responseHeader.reasonPhrase()));
@@ -179,6 +205,10 @@ void ConfigTab::readResponseHeader(const QHttpResponseHeader &responseHeader) {
        }
 }
 
+/**
+ * \brief Slot assigned to errMsgBox signal.
+ * \param text text to show.
+ */
 void ConfigTab::showMsgBox(const QString &text) {
        msgbox->clear();
        msgbox->setText(text);
index 047a4a375c0d97a13d4fd835580e1a761797a669..67ac0387a97c568acc01fdff17e3ebe8aaeacb56 100755 (executable)
@@ -25,6 +25,7 @@ http://creativecommons.org/licenses/by-nc-nd/2.5/legalcode
 
 extern void parse(const QString &);
 
+/// Config widget.
 class ConfigTab: public QWidget {
        Q_OBJECT
        QVBoxLayout *mainLayout, *group1Layout, *group2Layout;
index 62fdc4751ab63290ba95d64e8444bc5eb367f392..ce209230fcae7edc59e1ce418fa051604403ecec 100644 (file)
@@ -6,16 +6,25 @@ http://creativecommons.org/licenses/by-nc-nd/2.5/legalcode
 
 #include "loadtab.h"
 
+/**
+ * \brief Load Tab constructor.
+ */
 LoadTab::LoadTab(QWidget * parent) : QWidget(parent) {
        init();
 }
 
+/**
+ * \brief Load Tab destructor.
+ */
 LoadTab::~LoadTab() {
        delete label;
        delete older;
        delete mainLayout;
 }
 
+/**
+ * Init UI for this tab.
+ */
 void LoadTab::init() {
        QSettings settings("config/global.ini", QSettings::IniFormat);
        QString num = settings.value("nextXmlId", "0").toString();
@@ -26,7 +35,7 @@ void LoadTab::init() {
        
        int j = 0;
        for(int i=num.toInt()-1; i>=0; i--) {
-               quickparse("data/data_"+QString().setNum(i)+".xml");
+               quickparse("data/data_"+QString().setNum(i)+".xml");            // should be stored somewhere else
                if(globSlot) {
                        dataParsed[j][0] = globSlot;
                        dataParsed[j][1] = curSlot;
@@ -57,10 +66,17 @@ void LoadTab::init() {
        connect(older, SIGNAL(currentIndexChanged(int)), this, SLOT(indexChanged(int)));
 }
 
+/**
+ * \brief Slot assigned to data change action.
+ */
 void LoadTab::dataChanged() {
        rebuildUI();
 }
 
+/**
+ * \brief Slot assigned to combobox index change.
+ * \param i selected index.
+ */
 void LoadTab::indexChanged(int i) {
        int fileNum = dataParsed[i][3];
        parse("data/data_" + QString().setNum(fileNum) + ".xml");
@@ -69,6 +85,9 @@ void LoadTab::indexChanged(int i) {
        label->setText(tr("Loaded file: ") + "data_" + QString().setNum(fileNum) + ".xml");
 }
 
+/**
+ * \brief Delete UI and draw it again.
+ */
 void LoadTab::rebuildUI() {
        delete older;
        delete label;
index d72debf8110bf350bbcfcda614ac8a68f1346666..70f9da53b4f1f53f31632414ebf18a05808c3fa9 100644 (file)
--- a/loadtab.h
+++ b/loadtab.h
@@ -15,7 +15,7 @@ http://creativecommons.org/licenses/by-nc-nd/2.5/legalcode
 #include <QComboBox>
 #include <QDate>
 
-extern int dataParsed[20][4];  // glob slot || slot || seazon || data #
+extern int dataParsed[20][4];  // glob slot || slot || season || data #
 extern int globSlot;
 extern int curSlot;
 extern int curSeason;
@@ -23,6 +23,7 @@ extern int curSeason;
 extern void parse(const QString &);
 extern void quickparse(const QString &);
 
+/// Load Tab widget.
 class LoadTab: public QWidget {
        Q_OBJECT
        QVBoxLayout *mainLayout;
diff --git a/main.cc b/main.cc
index f112a346c4c9e6b91b5f68a3658d5dcffbcabb6e..632b23cd2fbbdcb8fa88879750c701bb6b785600 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 );
index ad44c8d6208ffc51f19d060502e55f14bac9dcd0..89fb885b3358e35aebe934bf2578c075fa7cfcec 100644 (file)
@@ -6,6 +6,9 @@ http://creativecommons.org/licenses/by-nc-nd/2.5/legalcode
 
 #include "mainwindow.h"
 
+/**
+ * \brief Main Window constructor.
+ */
 MainWindow::MainWindow(QWidget * parent) : QWidget(parent) {
        tabWidget = new QTabWidget;
        conf = new ConfigTab(this);
@@ -42,6 +45,9 @@ MainWindow::MainWindow(QWidget * parent) : QWidget(parent) {
        setLayout(mainLayout);
 }
 
+/**
+ * \brief Main Window destructor.
+ */
 MainWindow::~MainWindow() {
        delete conf;
        delete player;
index df0a47fbe7b897cbb37bf42f1cdf832d8c8d6bd4..1643cc2493f2c61edc5e0eb9f23259e778261ebd 100644 (file)
@@ -19,6 +19,11 @@ http://creativecommons.org/licenses/by-nc-nd/2.5/legalcode
 #include "abouttab.h"
 #include "performance.h"
 
+/**
+ * \brief Main Window widget.
+ *
+ * Holds all tabs inside it.
+ */
 class MainWindow: public QWidget {
        Q_OBJECT
        QVBoxLayout *mainLayout;
index 9da30aa0e80796d2e7b2917f36179bff1b2a199f..a5d3d7ee486441ce306f296d7c885de7e4968584 100644 (file)
@@ -6,6 +6,9 @@ http://creativecommons.org/licenses/by-nc-nd/2.5/legalcode
 
 #include "performance.h"
 
+/**
+ * \brief Init UI.
+ */
 void PerformanceTab::init() {
        QSettings settings("config/formation.ini", QSettings::IniFormat);
        
@@ -89,12 +92,18 @@ void PerformanceTab::init() {
        mainLayout->update();
 }
 
+/**
+ * \brief Performance Tab constructor.
+ */
 PerformanceTab::PerformanceTab(QWidget *parent): QWidget(parent), defs(0), mids(0), fors(0) {
        mainLayout = new QVBoxLayout;
        setLayout(mainLayout);
        init();
 }
 
+/**
+ * \brief Performance Tab destructor.
+ */
 PerformanceTab::~PerformanceTab() {
        for(int i=0; i<11; ++i) {
                delete player[i];
@@ -113,6 +122,9 @@ PerformanceTab::~PerformanceTab() {
        delete mainLayout;
 }
 
+/**
+ * \brief Slot assigned to data change action.
+ */
 void PerformanceTab::dataChanged() {
        container->removeWidget(format);
        delete format;
@@ -141,6 +153,9 @@ void PerformanceTab::dataChanged() {
        init();
 }
 
+/**
+ * \brief Set adequate player post by selected formation.
+ */
 void PerformanceTab::postLabels() {
        int LMpos = 0;
        if(!defsC) {
@@ -241,6 +256,11 @@ void PerformanceTab::postLabels() {
        }
 }
 
+/**
+ * \brief Count performance of each line (def, mid, fwd).
+ *
+ * Count with offensive/defensive order of each player.
+ */
 void PerformanceTab::countPerf() {
        defs = 0;
        mids = 0;
@@ -278,6 +298,11 @@ void PerformanceTab::countPerf() {
        }
 }
 
+/**
+ * \brief Slot assigned to "count performance" button.
+ *
+ * Print all play-variants points..
+ */
 void PerformanceTab::recount() {
        double homeMod = home->itemData(home->currentIndex()).toDouble();
        double pre = (1.0+((double)aggress/1000))/(7.0 - (club.spirit.toDouble()/1000) + homeMod);
@@ -294,6 +319,12 @@ void PerformanceTab::recount() {
        result->setText(text);
 }
 
+/**
+ * \brief Slot assigned to aggression change.
+ *
+ * \param[in] a Aggression ID.
+ * Save aggression to config file.
+ */
 void PerformanceTab::aggressChange(int a) {
        aggress = a*5;
        QSettings settings("config/formation.ini", QSettings::IniFormat);
@@ -301,6 +332,10 @@ void PerformanceTab::aggressChange(int a) {
        settings.sync();
 }
 
+/**
+ * \brief Slot assigned to formation change.
+ * \param[in] t Formation ID.
+ */
 void PerformanceTab::formatChange(int t) {
        QSettings settings("config/formation.ini", QSettings::IniFormat);
        if(t<8 && t>=0) { settings.setValue("form", t); settings.sync(); }
@@ -334,6 +369,10 @@ void PerformanceTab::formatChange(int t) {
        reorderPlayers();
 }
 
+/**
+ * \brief Slot assigned to player combobox changes.
+ * \param[in] id possition ID
+ */
 void PerformanceTab::playerChange(int id) {
        id = 1; //avoid warning :-D
        QSettings settings("config/formation.ini", QSettings::IniFormat);
@@ -344,6 +383,13 @@ void PerformanceTab::playerChange(int id) {
        settings.sync();
 }
 
+/**
+ * \brief Slot assigned to "re-order players" button.
+ *
+ * If there are players assigned to wrong possition (by selected formation),
+ * then this function give here players with correct post.
+ * This do not look at player performance, first is selected..
+ */
 void PerformanceTab::reorderPlayers() {
        int i;
        int from = 0;
@@ -404,6 +450,10 @@ void PerformanceTab::reorderPlayers() {
        }
 }
 
+/**
+ * \brief Searching for first player with this post.
+ * \param[in] post player possition.
+ */
 int PerformanceTab::findFirstOnPost(const QString &post) {
        for(int i=0; i<playerCnt; ++i) {
                if(post == pls[i].position) return i;
index ae65fb0bfb10b461020681c82f0f110346bfe92a..37d7835599afb53be6a84cddb49313baf8af8d33 100644 (file)
@@ -24,6 +24,7 @@ extern Player pls[];
 
 extern ClubStruct club;
 
+/// Performance widget.
 class PerformanceTab: public QWidget {
        Q_OBJECT
        QVBoxLayout *mainLayout;
index a97361b37a346a6d4f013d3d8f44cbee622e6ba3..abf8e3a69ff5d3aa0954da501fb9a37e01d1cad6 100755 (executable)
@@ -6,6 +6,9 @@ http://creativecommons.org/licenses/by-nc-nd/2.5/legalcode
 
 #include "playerdetail.h"
 
+/**
+ * \brief Player Detail Widget constructor.
+ */
 PlayerDetail::PlayerDetail(int idx, QWidget * parent): QWidget(parent), i(idx) {
        mainLayout = new QVBoxLayout;
        QString info = "<table>";
@@ -130,6 +133,9 @@ PlayerDetail::PlayerDetail(int idx, QWidget * parent): QWidget(parent), i(idx) {
        setLayout(mainLayout);
 }
 
+/**
+ * \brief Player Detail destructor.
+ */
 PlayerDetail::~PlayerDetail() {
        delete player;
        delete mainLayout;
index 9d1663edd3621e26c16b1c6312c679063ab70370..9a62ba27a83b82a61ce1544fbed32c10d08434d8 100755 (executable)
@@ -13,6 +13,7 @@ http://creativecommons.org/licenses/by-nc-nd/2.5/legalcode
 #include <QPushButton>
 #include <QLabel>
 
+/// Struct with information parsed for each player.
 struct Player {
        QString id;
        QString fname;
@@ -34,6 +35,7 @@ struct Player {
 extern Player pls[];
 extern int playerCnt;
 
+/// Player detail widget.
 class PlayerDetail: public QWidget {
        Q_OBJECT
        QVBoxLayout *mainLayout;
index 9c05369b06f0c2420916d784541c8491e17036da..d297a183144aac7401cbf98328c9609a1d1c8a83 100755 (executable)
@@ -6,6 +6,11 @@ http://creativecommons.org/licenses/by-nc-nd/2.5/legalcode
 
 #include "playertab.h"
 
+/**
+ * \brief Player Container constructor.
+ *
+ * Add player to adequate Tab by player possition (GK, LB etc.).
+ */
 PlayerCont::PlayerCont(int pos, QWidget *parent) : QWidget(parent) {
        tabWidget = new QTabWidget;
        tabWidget->setTabPosition(QTabWidget::West);
@@ -39,20 +44,34 @@ PlayerCont::PlayerCont(int pos, QWidget *parent) : QWidget(parent) {
        setLayout(mainLayout);
 }
 
+/**
+ * \brief Player Container destructor.
+ */
 PlayerCont::~PlayerCont() {
        delete tabWidget;
        delete mainLayout;
 }
 
+/**
+ * \brief Players Tab constructor.
+ *
+ * Hold player possition Tabs (GK, LB...).
+ */
 PlayerTab::PlayerTab(QWidget *parent) : QWidget(parent) {
        initTabs();
 }
 
+/**
+ * \brief Players Tab destructor.
+ */
 PlayerTab::~PlayerTab() {
        delete tabWidget;
        delete mainLayout;
 }
 
+/**
+ * \brief Init Player Tab - add Tabs with player possition.
+ */
 void PlayerTab::initTabs() {
        tabWidget = new QTabWidget;
        tabWidget->setTabPosition(QTabWidget::North);
@@ -73,10 +92,16 @@ void PlayerTab::initTabs() {
        setLayout(mainLayout);
 }
 
+/**
+ * \brief Slot assigned to data change action.
+ */
 void PlayerTab::dataChanged() {
        rebuildUI();
 }
 
+/**
+ * \brief Redraw UI with new data.
+ */
 void PlayerTab::rebuildUI() {
        delete tabWidget;
        delete mainLayout;
index f09a6f4bb0ed8767189b99ce79aea2f21a2c6918..c31efd0e9f3ae63f43ca78b49f12562376c02c2d 100755 (executable)
@@ -19,6 +19,7 @@ extern void parse(const QString &);
 extern int playerCnt;
 extern Player pls[];
 
+/// Container for players with same possition (GK, LB..)
 class PlayerCont: public QWidget {
        Q_OBJECT
        QTabWidget *tabWidget;
@@ -28,6 +29,7 @@ public:
        ~PlayerCont();
 };
 
+/// Widget with player possition Tabs.
 class PlayerTab: public QWidget {
        Q_OBJECT
        QTabWidget *tabWidget;
index 51de32b7d1e97887869a21ac6329a1e64973491e..6da3d4afccc435b5212ba5c8f0be9773254ad4fe 100644 (file)
@@ -6,6 +6,9 @@ http://creativecommons.org/licenses/by-nc-nd/2.5/legalcode
 
 #include "proxyset.h"
 
+/**
+ * \brief Proxy settings widget constructor.
+ */
 ProxySet::ProxySet(QWidget *parent) : QWidget(parent) {
        QSettings settings("config/global.ini", QSettings::IniFormat);
        useProxy = settings.value("Network/proxyUsed", 0).toInt();
@@ -43,6 +46,9 @@ ProxySet::ProxySet(QWidget *parent) : QWidget(parent) {
        this->show();
 }
 
+/**
+ * \brief Proxy settings destructor.
+ */
 ProxySet::~ProxySet() {
        delete addrP;
        delete portP;
@@ -57,6 +63,9 @@ ProxySet::~ProxySet() {
        delete mainLayout;
 }
 
+/**
+ * \brief Slot assigned to save button click.
+ */
 void ProxySet::save() {
        QSettings settings("config/global.ini", QSettings::IniFormat);
        settings.setValue("Network/proxyUsed", useProxy);
@@ -67,6 +76,9 @@ void ProxySet::save() {
        settings.sync();
 }
 
+/**
+ * \brief Slot assigned to check box changes.
+ */
 void ProxySet::checkChange(int state) {
        useProxy = state;
 }
index a9d388ce157799f3a7ac35e1ab2503406e908e33..d231afe264e053fe2d23d7b1c13f0892bfb1a54a 100644 (file)
@@ -15,6 +15,7 @@ http://creativecommons.org/licenses/by-nc-nd/2.5/legalcode
 #include <QLineEdit>
 #include <QSettings>
 
+/// Proxy settings widget.
 class ProxySet: public QWidget {
        Q_OBJECT
        QVBoxLayout *mainLayout;
index 97f027b989e8943d51fb6894ce25a637b0fbdc9a..82f4b3717dfb63c40e47b606d11d0f741300c966 100644 (file)
@@ -6,17 +6,26 @@ http://creativecommons.org/licenses/by-nc-nd/2.5/legalcode
 
 #include "stadiumtab.h"
 
+/**
+ * \brief Stadium Tab constructor.
+ */
 StadiumTab::StadiumTab(QWidget *parent) : QWidget(parent) {
        mainLayout = new QVBoxLayout;
        setLayout(mainLayout);
        init();
 }
 
+/**
+ * \brief Stadium Tab destructor.
+ */
 StadiumTab::~StadiumTab() {
        delete label;
        delete mainLayout;
 }
 
+/**
+ * \brief Print info about stadium from parsed data.
+ */
 void StadiumTab::init() {
        int cap = stadium.cap_n.toInt() + stadium.cap_e.toInt() + stadium.cap_w.toInt() + stadium.cap_s.toInt();
        QString text;
@@ -58,10 +67,16 @@ void StadiumTab::init() {
        mainLayout->update();
 }
 
+/**
+ * \brief Slot assigned to data change action.
+ */
 void StadiumTab::dataChanged() {
        rebuildUI();
 }
 
+/**
+ * \brief Destroy current UI and draw it again.
+ */
 void StadiumTab::rebuildUI() {
        mainLayout->removeWidget(label);
        delete label;
index 7db1513a00ce4576b5eb3542baa63a8d6c72637d..5cee158a412072edb8db11115e1007eee05672a2 100644 (file)
@@ -20,6 +20,7 @@ struct StadiumStruct {
 extern void parse(const QString &);
 extern StadiumStruct stadium;
 
+/// Stadium Tab widget.
 class StadiumTab: public QWidget {
        Q_OBJECT
        QVBoxLayout *mainLayout;
index afb512b483e5835c112220c678414d034bf02e62..9e834d5c93d207d9767561a4b1a460783e1c1d51 100644 (file)
@@ -6,6 +6,12 @@ http://creativecommons.org/licenses/by-nc-nd/2.5/legalcode
 
 #include "staffmember.h"
 
+/**
+ * \brief Staff Member constructor.
+ *
+ * Display info about requested staff.
+ * \param idx staff member ID.
+ */
 StaffMember::StaffMember(int idx, QWidget *parent): QWidget(parent), i(idx) {
        mainLayout = new QVBoxLayout;
        QString info = "<table cellspacing=\"3\">";
@@ -34,6 +40,9 @@ StaffMember::StaffMember(int idx, QWidget *parent): QWidget(parent), i(idx) {
        setLayout(mainLayout);
 }
 
+/**
+ * \brief Staff member destructor.
+ */
 StaffMember::~StaffMember() {
        delete player;
        delete mainLayout;
index fbf3dc97cb675f3c5cac6d9f1de0a59e2beab146..8db88eda6e9aa2f2d3143e7dd6d9e00c3230ef03 100644 (file)
@@ -29,6 +29,7 @@ struct StaffMemberStruct {
 extern StaffMemberStruct staff[];
 extern int staffCnt;
 
+/// Staff widget.
 class StaffMember: public QWidget {
        Q_OBJECT
        QVBoxLayout *mainLayout;
index da5a9652ddf2b0ef2f2bf943b0477877c6a61fd7..cfb8087243e830076217a3bcfce1a19568e9f535 100644 (file)
@@ -6,15 +6,24 @@ http://creativecommons.org/licenses/by-nc-nd/2.5/legalcode
 
 #include "stafftab.h"
 
+/**
+ * \brief Staff Tab constructor.
+ */
 StaffTab::StaffTab(QWidget *parent) : QWidget(parent) {
        initTabs();
 }
 
+/**
+ * \brief Staff Tab destructor.
+ */
 StaffTab::~StaffTab() {
        delete tabWidget;
        delete mainLayout;
 }
 
+/**
+ * \brief Add tabs for each staff members.
+ */
 void StaffTab::initTabs() {
        tabWidget = new QTabWidget;
        tabWidget->setTabPosition(QTabWidget::West);
@@ -27,10 +36,16 @@ void StaffTab::initTabs() {
        setLayout(mainLayout);
 }
 
+/**
+ * \brief Slot assigned to data change action.
+ */
 void StaffTab::dataChanged() {
        rebuildUI();
 }
 
+/**
+ * \brief Delete widget and draw it again.
+ */
 void StaffTab::rebuildUI() {
        delete tabWidget;
        delete mainLayout;
index 1818a573052e515936dccc642c02d9c05fdfc8c0..1b194578b63445b0ede3153b632e020afff943e1 100644 (file)
@@ -19,6 +19,7 @@ extern void parse(const QString &);
 extern int staffCnt;
 extern StaffMemberStruct staff[];
 
+/// Staff Tab widget.
 class StaffTab: public QWidget {
        Q_OBJECT
        QTabWidget *tabWidget;