diff options
author | alberth <alberth@openttd.org> | 2010-11-21 12:12:23 +0000 |
---|---|---|
committer | alberth <alberth@openttd.org> | 2010-11-21 12:12:23 +0000 |
commit | 297414164135627266438efef673ace008410519 (patch) | |
tree | 2b486a0a8e016e336f990f6d94a9b3a83d825969 /src/saveload/saveload.cpp | |
parent | f70202bfa832c97f8f4ce35ad5cdaa8dba810797 (diff) | |
download | openttd-297414164135627266438efef673ace008410519.tar.xz |
(svn r21281) -Doc: Add doxygen comments to saveload code.
Diffstat (limited to 'src/saveload/saveload.cpp')
-rw-r--r-- | src/saveload/saveload.cpp | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/src/saveload/saveload.cpp b/src/saveload/saveload.cpp index 557ea29f1..cf2ddb2b5 100644 --- a/src/saveload/saveload.cpp +++ b/src/saveload/saveload.cpp @@ -304,6 +304,7 @@ extern const ChunkHandler _labelmaps_chunk_handlers[]; extern const ChunkHandler _airport_chunk_handlers[]; extern const ChunkHandler _object_chunk_handlers[]; +/** Array of all chunks in a savegame, \c NULL terminated. */ static const ChunkHandler * const _chunk_handlers[] = { _gamelog_chunk_handlers, _map_chunk_handlers, @@ -2273,6 +2274,7 @@ static SaveOrLoadResult SaveFileToDisk(bool threaded) } } +/** Thread run function for saving the file to disk. */ static void SaveFileToDiskThread(void *arg) { SaveFileToDisk(true); @@ -2291,10 +2293,10 @@ void WaitTillSaved() * Main Save or Load function where the high-level saveload functions are * handled. It opens the savegame, selects format and checks versions * @param filename The name of the savegame being created/loaded - * @param mode Save or load. Load can also be a TTD(Patch) game. Use SL_LOAD, SL_OLD_LOAD or SL_SAVE + * @param mode Save or load mode. Load can also be a TTD(Patch) game. Use #SL_LOAD, #SL_OLD_LOAD, #SL_LOAD_CHECK, or #SL_SAVE. * @param sb The sub directory to save the savegame in * @param threaded True when threaded saving is allowed - * @return Return the results of the action. SL_OK, SL_ERROR or SL_REINIT ("unload" the game) + * @return Return the result of the action. #SL_OK, #SL_ERROR, or #SL_REINIT ("unload" the game) */ SaveOrLoadResult SaveOrLoad(const char *filename, int mode, Subdirectory sb, bool threaded) { |