diff options
| author | Charles Pigott <charlespigott@googlemail.com> | 2018-10-28 02:17:36 +0000 |
|---|---|---|
| committer | frosch <github@elsenhans.name> | 2018-10-31 12:35:54 +0100 |
| commit | f5b1115039e41d7f75f91e7355003f10dd01b352 (patch) | |
| tree | c777655761bcdca584fe0ff5c2f0e87fc2ef14e8 /src/saveload | |
| parent | b9273cbe07aa47daa8a9d2411062dfd7fead27de (diff) | |
| download | openttd-f5b1115039e41d7f75f91e7355003f10dd01b352.tar.xz | |
Doc: Lots and lots of doxymentation fixes
Diffstat (limited to 'src/saveload')
| -rw-r--r-- | src/saveload/linkgraph_sl.cpp | 2 | ||||
| -rw-r--r-- | src/saveload/saveload.cpp | 2 | ||||
| -rw-r--r-- | src/saveload/saveload.h | 6 |
3 files changed, 5 insertions, 5 deletions
diff --git a/src/saveload/linkgraph_sl.cpp b/src/saveload/linkgraph_sl.cpp index a65f4fc8a..6044316a4 100644 --- a/src/saveload/linkgraph_sl.cpp +++ b/src/saveload/linkgraph_sl.cpp @@ -132,7 +132,7 @@ static const SaveLoad _edge_desc[] = { /** * Save/load a link graph. - * @param comp Link graph to be saved or loaded. + * @param lg Link graph to be saved or loaded. */ void SaveLoad_LinkGraph(LinkGraph &lg) { diff --git a/src/saveload/saveload.cpp b/src/saveload/saveload.cpp index f9c3efd75..f23d13a08 100644 --- a/src/saveload/saveload.cpp +++ b/src/saveload/saveload.cpp @@ -2786,7 +2786,7 @@ SaveOrLoadResult LoadWithFilter(LoadFilter *reader) * 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 mode. Load can also be a TTD(Patch) game. Use #SL_LOAD, #SL_OLD_LOAD, #SL_LOAD_CHECK, or #SL_SAVE. + * @param fop Save or load mode. Load can also be a TTD(Patch) game. * @param sb The sub directory to save the savegame in * @param threaded True when threaded saving is allowed * @return Return the result of the action. #SL_OK, #SL_ERROR, or #SL_REINIT ("unload" the game) diff --git a/src/saveload/saveload.h b/src/saveload/saveload.h index 3405f3351..cca56ce07 100644 --- a/src/saveload/saveload.h +++ b/src/saveload/saveload.h @@ -488,7 +488,7 @@ static inline bool SlIsObjectCurrentlyValid(uint16 version_from, uint16 version_ * Get the NumberType of a setting. This describes the integer type * as it is represented in memory * @param type VarType holding information about the variable-type - * @return return the SLE_VAR_* part of a variable-type description + * @return the SLE_VAR_* part of a variable-type description */ static inline VarType GetVarMemType(VarType type) { @@ -496,10 +496,10 @@ static inline VarType GetVarMemType(VarType type) } /** - * Get the #FileType of a setting. This describes the integer type + * Get the FileType of a setting. This describes the integer type * as it is represented in a savegame/file * @param type VarType holding information about the file-type - * @param return the SLE_FILE_* part of a variable-type description + * @return the SLE_FILE_* part of a variable-type description */ static inline VarType GetVarFileType(VarType type) { |