diff options
| author | alberth <alberth@openttd.org> | 2012-12-01 13:12:39 +0000 |
|---|---|---|
| committer | alberth <alberth@openttd.org> | 2012-12-01 13:12:39 +0000 |
| commit | 732e073261a0c9f2d644475ec800f5acae90ec94 (patch) | |
| tree | ed921e856ce535c64e5542357fb942192a656df0 /src/cargotype.h | |
| parent | 01d023ad3bd9f33c702aa523e2b8efbdbe3f61f9 (diff) | |
| download | openttd-732e073261a0c9f2d644475ec800f5acae90ec94.tar.xz | |
(svn r24776) -Doc: Typo fixes, additions, and additional dots collected from various sources (including Eagle_rainbow, MinchinWeb)
Diffstat (limited to 'src/cargotype.h')
| -rw-r--r-- | src/cargotype.h | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/src/cargotype.h b/src/cargotype.h index b1605fb20..74fa5a998 100644 --- a/src/cargotype.h +++ b/src/cargotype.h @@ -157,8 +157,18 @@ static inline bool IsCargoInClass(CargoID c, CargoClass cc) #define FOR_EACH_SET_CARGO_ID(var, cargo_bits) FOR_EACH_SET_BIT_EX(CargoID, var, uint, cargo_bits) +/** + * Loop header for iterating over cargoes, sorted by name. This includes phony cargoes like regearing cargoes. + * @param var Reference getting the cargospec. + * @see CargoSpec + */ #define FOR_ALL_SORTED_CARGOSPECS(var) for (uint8 index = 0; var = _sorted_cargo_specs[index], index < _sorted_cargo_specs_size; index++) +/** + * Loop header for iterating over 'real' cargoes, sorted by name. Phony cargoes like regearing cargoes are skipped. + * @param var Reference getting the cargospec. + * @see CargoSpec + */ #define FOR_ALL_SORTED_STANDARD_CARGOSPECS(var) for (uint8 index = 0; var = _sorted_cargo_specs[index], index < _sorted_standard_cargo_specs_size; index++) #endif /* CARGOTYPE_H */ |