diff options
author | belugas <belugas@openttd.org> | 2007-04-04 01:35:16 +0000 |
---|---|---|
committer | belugas <belugas@openttd.org> | 2007-04-04 01:35:16 +0000 |
commit | dfe5533db674cf2f21652f91cf626831a22344ec (patch) | |
tree | c8c468b064c05fa682d00013b36792570a637721 /src/saveload.h | |
parent | f12d1a3f0a0978464dad84c1b31752aece298321 (diff) | |
download | openttd-dfe5533db674cf2f21652f91cf626831a22344ec.tar.xz |
(svn r9556) -Documentation: doxygen and comment-style changes. 'R', 'S'.. The end of the preliminary work is near
Diffstat (limited to 'src/saveload.h')
-rw-r--r-- | src/saveload.h | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/src/saveload.h b/src/saveload.h index f5bf82489..9148ab5a5 100644 --- a/src/saveload.h +++ b/src/saveload.h @@ -1,5 +1,7 @@ /* $Id$ */ +/** @file saveload.h */ + #ifndef SAVELOAD_H #define SAVELOAD_H @@ -10,9 +12,9 @@ #define SIZE_MAX ((size_t)-1) enum SaveOrLoadResult { - SL_OK = 0, // completed successfully - SL_ERROR = 1, // error that was caught before internal structures were modified - SL_REINIT = 2, // error that was caught in the middle of updating game state, need to clear it. (can only happen during load) + SL_OK = 0, ///< completed successfully + SL_ERROR = 1, ///< error that was caught before internal structures were modified + SL_REINIT = 2, ///< error that was caught in the middle of updating game state, need to clear it. (can only happen during load) }; enum SaveOrLoadMode { |