summaryrefslogtreecommitdiff
path: root/src/newgrf_industries.h
diff options
context:
space:
mode:
authoralberth <alberth@openttd.org>2012-11-10 20:46:39 +0000
committeralberth <alberth@openttd.org>2012-11-10 20:46:39 +0000
commit33ff55a8f1287643986621e7130e8acddf42b221 (patch)
tree04af02a5ad82e979ec200570b38628dccc860cdf /src/newgrf_industries.h
parent4c9bea2a714da675217522c39113ba2c2c5bbee4 (diff)
downloadopenttd-33ff55a8f1287643986621e7130e8acddf42b221.tar.xz
(svn r24693) -Doc: Add some doxymentation into the newgrf code.
Diffstat (limited to 'src/newgrf_industries.h')
-rw-r--r--src/newgrf_industries.h14
1 files changed, 8 insertions, 6 deletions
diff --git a/src/newgrf_industries.h b/src/newgrf_industries.h
index cb1e7f21c..5c95fcdcb 100644
--- a/src/newgrf_industries.h
+++ b/src/newgrf_industries.h
@@ -14,11 +14,12 @@
#include "newgrf_town.h"
+/** Resolver for industry scopes. */
struct IndustriesScopeResolver : public ScopeResolver {
- TileIndex tile;
- Industry *industry;
- IndustryType type;
- uint32 random_bits; ///< Random bits of the new industry.
+ TileIndex tile; ///< Tile owned by the industry.
+ Industry *industry; ///< %Industry being resolved.
+ IndustryType type; ///< Type of the industry.
+ uint32 random_bits; ///< Random bits of the new industry.
IndustriesScopeResolver(ResolverObject *ro, TileIndex tile, Industry *industry, IndustryType type, uint32 random_bits = 0);
@@ -29,9 +30,10 @@ struct IndustriesScopeResolver : public ScopeResolver {
/* virtual */ void StorePSA(uint pos, int32 value);
};
+/** Resolver for industries. */
struct IndustriesResolverObject : public ResolverObject {
- IndustriesScopeResolver industries_scope;
- TownScopeResolver *town_scope;
+ IndustriesScopeResolver industries_scope; ///< Scope resolver for the industry.
+ TownScopeResolver *town_scope; ///< Scope resolver for the associated town (if needed and available, else \c NULL).
IndustriesResolverObject(TileIndex tile, Industry *indus, IndustryType type, uint32 random_bits = 0,
CallbackID callback = CBID_NO_CALLBACK, uint32 callback_param1 = 0, uint32 callback_param2 = 0);