summaryrefslogtreecommitdiff
path: root/src/order_backup.h
diff options
context:
space:
mode:
authorrubidium <rubidium@openttd.org>2011-05-02 16:14:23 +0000
committerrubidium <rubidium@openttd.org>2011-05-02 16:14:23 +0000
commit4d5dbf51707c42c24eeafdb65016b079c54adcf2 (patch)
tree0197dcc17f4a8411ecea2223f356019c902fe7b9 /src/order_backup.h
parente9837ff1ec1326aec622366ae29ff1aa81581daf (diff)
downloadopenttd-4d5dbf51707c42c24eeafdb65016b079c54adcf2.tar.xz
(svn r22410) -Document: some more bits ;)
Diffstat (limited to 'src/order_backup.h')
-rw-r--r--src/order_backup.h10
1 files changed, 10 insertions, 0 deletions
diff --git a/src/order_backup.h b/src/order_backup.h
index 51281e860..583d4a853 100644
--- a/src/order_backup.h
+++ b/src/order_backup.h
@@ -69,7 +69,17 @@ public:
static void ClearVehicle(const Vehicle *v);
};
+/**
+ * Iterator over all order backups from a given ID.
+ * @param var The variable to iterate with.
+ * @param start The start of the iteration.
+ */
#define FOR_ALL_ORDER_BACKUPS_FROM(var, start) FOR_ALL_ITEMS_FROM(OrderBackup, order_backup_index, var, start)
+
+/**
+ * Iterator over all order backups.
+ * @param var The variable to iterate with.
+ */
#define FOR_ALL_ORDER_BACKUPS(var) FOR_ALL_ORDER_BACKUPS_FROM(var, 0)
#endif /* ORDER_BACKUP_H */