diff options
author | rubidium <rubidium@openttd.org> | 2011-05-02 17:42:12 +0000 |
---|---|---|
committer | rubidium <rubidium@openttd.org> | 2011-05-02 17:42:12 +0000 |
commit | fb5ecb94992e7febf4bc059cb6ec4a51f50c66b0 (patch) | |
tree | 87956636c318baa8d5d8d62f13263c4f64dbe881 /src/economy_base.h | |
parent | 4d5dbf51707c42c24eeafdb65016b079c54adcf2 (diff) | |
download | openttd-fb5ecb94992e7febf4bc059cb6ec4a51f50c66b0.tar.xz |
(svn r22411) -Document: another bunch of bits
Diffstat (limited to 'src/economy_base.h')
-rw-r--r-- | src/economy_base.h | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/src/economy_base.h b/src/economy_base.h index edad76ed2..742d01878 100644 --- a/src/economy_base.h +++ b/src/economy_base.h @@ -48,7 +48,17 @@ struct CargoPayment : CargoPaymentPool::PoolItem<&_cargo_payment_pool> { void SetCargo(CargoID ct) { this->ct = ct; } }; +/** + * Iterate over all cargo payments from a given start position. + * @param var The variable used for iterating. + * @param start The start of the iteration. + */ #define FOR_ALL_CARGO_PAYMENTS_FROM(var, start) FOR_ALL_ITEMS_FROM(CargoPayment, cargo_payment_index, var, start) + +/** + * Iterate over all cargo payments. + * @param var The variable used for iterating. + */ #define FOR_ALL_CARGO_PAYMENTS(var) FOR_ALL_CARGO_PAYMENTS_FROM(var, 0) #endif /* ECONOMY_BASE_H */ |