(svn r21886) -Codechange: move documentation towards the code to make it more likely to be updated [n].

This commit is contained in:
rubidium
2011-01-22 09:53:15 +00:00
parent 0cdb1c78cd
commit eb299736c1
33 changed files with 338 additions and 364 deletions

View File

@@ -72,12 +72,6 @@ struct ObjectSpec {
uint8 views; ///< The number of views.
bool enabled; ///< Is this spec enabled?
/**
* Check whether the object is available at this time.
* @return true if it is available.
*/
bool IsAvailable() const;
/**
* Get the cost for building a structure of this type.
* @return The cost for building.
@@ -90,24 +84,10 @@ struct ObjectSpec {
*/
Money GetClearCost() const { return (_price[PR_CLEAR_OBJECT] * this->clear_cost_multiplier); }
/**
* Gets the index of this spec.
* @return The index.
*/
bool IsAvailable() const;
uint Index() const;
/**
* Get the specification associated with a specific ObjectType.
* @param index The object type to fetch.
* @return The specification.
*/
static const ObjectSpec *Get(ObjectType index);
/**
* Get the specification associated with a tile.
* @param tile The tile to fetch the data for.
* @return The specification.
*/
static const ObjectSpec *GetByTile(TileIndex tile);
};