Added namespace and file comments

Namespaces Glest and Game are now commented. To avoid unnecessary
duplication, they're only commented in one place (main.cpp).
This commit is contained in:
Mike Hoffert 2014-07-21 21:02:31 -06:00
parent d6668b7e85
commit 488ff4f462
3 changed files with 24 additions and 0 deletions

View File

@ -101,6 +101,14 @@ using namespace Shared::Graphics::Gl;
using namespace Shared::Xml;
using namespace Shared;
/**
* @namespace Glest
* Namespace used for all %Glest related code.
*/
/**
* @namespace Game
* Namespace used for game related code.
*/
namespace Glest { namespace Game {
static string tempDataLocation = getUserHome();

View File

@ -9,6 +9,13 @@
// License, or (at your option) any later version
// ==============================================================
/**
* @file
* Contains the Upgrade and UpgradeManager classes. This is what the factions need to manage
* upgrades (including starting, canceling, and finishing upgrades, figuring out which
* upgrades we have done, etc).
*/
#ifndef _GLEST_GAME_UPGRADE_H_
#define _GLEST_GAME_UPGRADE_H_
@ -36,6 +43,7 @@ class Faction;
/**
* Stores the state of the upgrade (whether or not the upgrading process is complete).
*/
// TODO: Don't make this global; move it inside Upgrade
enum UpgradeState {
usUpgrading, /**< The upgrade is currently in progress. */
usUpgraded, /**< The upgrade is completed. */

View File

@ -9,6 +9,14 @@
// License, or (at your option) any later version
// ==============================================================
/**
* @file
* Classified the Upgrade type (which is sort of like a class for upgrades). Each upgrade has a
* type that details the stats that it boosts and the units that it affects. Also has TotalUpgrade,
* which is a sum of all upgrades applied to a particular unit (and is what determines how units
* stats are modified by an upgrade.
*/
#ifndef _GLEST_GAME_UPGRADETYPE_H_
#define _GLEST_GAME_UPGRADETYPE_H_