various comment tweaks/fixes
authorsheepluva
Sat, 28 Apr 2012 12:35:29 +0200
changeset 6948 7271ce89950f
parent 6947 1be3e48e1d53
child 6949 615cc50903c8
various comment tweaks/fixes
QTfrontend/model/MapModel.cpp
QTfrontend/model/MapModel.h
QTfrontend/model/ThemeModel.cpp
QTfrontend/model/ThemeModel.h
QTfrontend/ui/widget/databrowser.cpp
QTfrontend/ui/widget/databrowser.h
QTfrontend/util/DataManager.cpp
QTfrontend/util/DataManager.h
--- a/QTfrontend/model/MapModel.cpp	Sat Apr 28 11:56:09 2012 +0200
+++ b/QTfrontend/model/MapModel.cpp	Sat Apr 28 12:35:29 2012 +0200
@@ -1,7 +1,6 @@
 /*
  * Hedgewars, a free turn based strategy game
- * Copyright (c) 2006-2007 Igor Ulyanov <iulyanov@gmail.com>
- * Copyright (c) 2007-2012 Andrey Korotaev <unC0Rr@gmail.com>
+ * Copyright (c) 2012 Andrey Korotaev <unC0Rr@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
@@ -219,8 +218,5 @@
     qvar.setValue(mapInfo);
     item->setData(qvar, Qt::UserRole + 1);
 
-    if (mapInfo.type == Invalid)
-            Q_ASSERT(false);
-
     return item;
 }
--- a/QTfrontend/model/MapModel.h	Sat Apr 28 11:56:09 2012 +0200
+++ b/QTfrontend/model/MapModel.h	Sat Apr 28 12:35:29 2012 +0200
@@ -1,7 +1,6 @@
 /*
  * Hedgewars, a free turn based strategy game
- * Copyright (c) 2006-2007 Igor Ulyanov <iulyanov@gmail.com>
- * Copyright (c) 2007-2012 Andrey Korotaev <unC0Rr@gmail.com>
+ * Copyright (c) 2012 Andrey Korotaev <unC0Rr@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
@@ -81,12 +80,12 @@
 
 
     public slots:
-        /// reloads the maps using the DataManager
+        /// Reloads the maps using the DataManager.
         void loadMaps();
 
 
     private:
-        ///< start-index and map count for each map-type
+        /// start-index and map count for each map-type.
         QMap<MapType, QPair<int,int> > typeLoc;
 
         /**
--- a/QTfrontend/model/ThemeModel.cpp	Sat Apr 28 11:56:09 2012 +0200
+++ b/QTfrontend/model/ThemeModel.cpp	Sat Apr 28 12:35:29 2012 +0200
@@ -1,3 +1,25 @@
+/*
+ * Hedgewars, a free turn based strategy game
+ * Copyright (c) 2012 Andrey Korotaev <unC0Rr@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
+ * the Free Software Foundation; version 2 of the License
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
+ */
+
+/**
+ * @file
+ * @brief ThemeModel class implementation
+ */
 
 #include "ThemeModel.h"
 
--- a/QTfrontend/model/ThemeModel.h	Sat Apr 28 11:56:09 2012 +0200
+++ b/QTfrontend/model/ThemeModel.h	Sat Apr 28 12:35:29 2012 +0200
@@ -1,7 +1,6 @@
 /*
  * Hedgewars, a free turn based strategy game
- * Copyright (c) 2006-2007 Igor Ulyanov <iulyanov@gmail.com>
- * Copyright (c) 2007-2012 Andrey Korotaev <unC0Rr@gmail.com>
+ * Copyright (c) 2012 Andrey Korotaev <unC0Rr@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
--- a/QTfrontend/ui/widget/databrowser.cpp	Sat Apr 28 11:56:09 2012 +0200
+++ b/QTfrontend/ui/widget/databrowser.cpp	Sat Apr 28 12:35:29 2012 +0200
@@ -1,3 +1,26 @@
+/*
+ * Hedgewars, a free turn based strategy game
+ * Copyright (c) 2011-2012 Andrey Korotaev <unC0Rr@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
+ * the Free Software Foundation; version 2 of the License
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
+ */
+
+/**
+ * @file
+ * @brief DataBrowser class implementation
+ */
+
 #include <QNetworkAccessManager>
 #include <QNetworkRequest>
 #include <QNetworkReply>
--- a/QTfrontend/ui/widget/databrowser.h	Sat Apr 28 11:56:09 2012 +0200
+++ b/QTfrontend/ui/widget/databrowser.h	Sat Apr 28 12:35:29 2012 +0200
@@ -1,5 +1,28 @@
-#ifndef DATABROWSER_H
-#define DATABROWSER_H
+/*
+ * Hedgewars, a free turn based strategy game
+ * Copyright (c) 2011-2012 Andrey Korotaev <unC0Rr@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
+ * the Free Software Foundation; version 2 of the License
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
+ */
+
+/**
+ * @file
+ * @brief DataBrowser class definition
+ */
+
+#ifndef HEDGEWARS_DATABROWSER_H
+#define HEDGEWARS_DATABROWSER_H
 
 #include <QTextBrowser>
 #include <QSet>
@@ -30,4 +53,4 @@
         void resourceDownloaded();
 };
 
-#endif // DATABROWSER_H
+#endif // HEDGEWARS_DATABROWSER_H
--- a/QTfrontend/util/DataManager.cpp	Sat Apr 28 11:56:09 2012 +0200
+++ b/QTfrontend/util/DataManager.cpp	Sat Apr 28 12:35:29 2012 +0200
@@ -1,7 +1,6 @@
 /*
  * Hedgewars, a free turn based strategy game
- * Copyright (c) 2006-2007 Igor Ulyanov <iulyanov@gmail.com>
- * Copyright (c) 2007-2012 Andrey Korotaev <unC0Rr@gmail.com>
+ * Copyright (c) 2011-2012 Andrey Korotaev <unC0Rr@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
--- a/QTfrontend/util/DataManager.h	Sat Apr 28 11:56:09 2012 +0200
+++ b/QTfrontend/util/DataManager.h	Sat Apr 28 12:35:29 2012 +0200
@@ -1,7 +1,6 @@
 /*
  * Hedgewars, a free turn based strategy game
- * Copyright (c) 2006-2007 Igor Ulyanov <iulyanov@gmail.com>
- * Copyright (c) 2007-2012 Andrey Korotaev <unC0Rr@gmail.com>
+ * Copyright (c) 2011-2012 Andrey Korotaev <unC0Rr@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
@@ -98,7 +97,7 @@
         /**
          * @brief Returns pointer to a model for the available maps.
          *
-         * The model is kept up to date automatically.
+         * The model is updated automatically on data reload.
          *
          * @return map model pointer.
          */
@@ -107,23 +106,19 @@
         /**
          * @brief Returns pointer to a model for the available themes.
          *
-         * The model is kept up to date automatically.
+         * The model is updated automatically on data reload.
          *
          * @return theme model pointer.
          */
         ThemeModel * themeModel();
 
     public slots:
-        /**
-         * @brief Reloads data from storage.
-         */
+        /// Reloads data from storage.
         void reload();
 
 
     signals:
-        /**
-         * @brief This signal is emitted after the data has been updated.
-         */
+        /// This signal is emitted after the data has been updated.
         void updated();