(svn r24693) -Doc: Add some doxymentation into the newgrf code.

This commit is contained in:
alberth
2012-11-10 20:46:39 +00:00
parent 8a297ca5f1
commit 6c1ff5f772
24 changed files with 276 additions and 49 deletions

View File

@@ -15,13 +15,15 @@
#include "town_type.h"
#include "newgrf_spritegroup.h"
/* Currently there is no direct town resolver; we only need to get town
* variable results from inside stations, house tiles and industries,
* and to check the town's persistent storage.
/**
* Scope resolver for a town.
* @note Currently there is no direct town resolver; we only need to get town
* variable results from inside stations, house tiles and industries,
* and to check the town's persistent storage.
*/
struct TownScopeResolver : public ScopeResolver {
Town *t;
bool readonly;
Town *t; ///< %Town of the scope.
bool readonly; ///< When set, persistent storage of the town is read-only,
TownScopeResolver(ResolverObject *ro, Town *t, bool readonly);
@@ -29,8 +31,9 @@ struct TownScopeResolver : public ScopeResolver {
virtual void StorePSA(uint reg, int32 value);
};
/** Resolver of town properties. */
struct TownResolverObject : public ResolverObject {
TownScopeResolver town_scope;
TownScopeResolver town_scope; ///< Scope resolver specific for towns.
TownResolverObject(const struct GRFFile *grffile, Town *t, bool readonly);