From ed4f806f1dcff2e10d2fdfb687e6bcebe9a81af3 Mon Sep 17 00:00:00 2001 From: frosch Date: Sun, 1 Aug 2010 19:22:34 +0000 Subject: (svn r20283) -Codechange: Unify start of doygen comments. --- src/saveload/afterload.cpp | 3 ++- src/saveload/airport_sl.cpp | 3 ++- src/saveload/order_sl.cpp | 6 ++++-- src/saveload/saveload.cpp | 21 ++++++++++++++------- src/saveload/saveload.h | 15 ++++++++++----- 5 files changed, 32 insertions(+), 16 deletions(-) (limited to 'src/saveload') diff --git a/src/saveload/afterload.cpp b/src/saveload/afterload.cpp index 6c0f9a7d8..2ce446511 100644 --- a/src/saveload/afterload.cpp +++ b/src/saveload/afterload.cpp @@ -2153,7 +2153,8 @@ bool AfterLoadGame() return true; } -/** Reload all NewGRF files during a running game. This is a cut-down +/** + * Reload all NewGRF files during a running game. This is a cut-down * version of AfterLoadGame(). * XXX - We need to reset the vehicle position hash because with a non-empty * hash AfterLoadVehicles() will loop infinitely. We need AfterLoadVehicles() diff --git a/src/saveload/airport_sl.cpp b/src/saveload/airport_sl.cpp index 933114388..893bcc070 100644 --- a/src/saveload/airport_sl.cpp +++ b/src/saveload/airport_sl.cpp @@ -14,7 +14,8 @@ #include "saveload.h" -/** Save and load the mapping between the airport id in the AirportSpec array +/** + * Save and load the mapping between the airport id in the AirportSpec array * and the grf file it came from. */ static const SaveLoad _airport_id_mapping_desc[] = { SLE_VAR(EntityIDMapping, grfid, SLE_UINT32), diff --git a/src/saveload/order_sl.cpp b/src/saveload/order_sl.cpp index 4c285d743..71bb09bd0 100644 --- a/src/saveload/order_sl.cpp +++ b/src/saveload/order_sl.cpp @@ -66,7 +66,8 @@ void Order::ConvertFromOldSavegame() } } -/** Unpacks a order from savegames with version 4 and lower +/** + * Unpacks a order from savegames with version 4 and lower * @param packed packed order * @return unpacked order */ @@ -75,7 +76,8 @@ static Order UnpackVersion4Order(uint16 packed) return Order(GB(packed, 8, 8) << 16 | GB(packed, 4, 4) << 8 | GB(packed, 0, 4)); } -/** Unpacks a order from savegames made with TTD(Patch) +/** + * Unpacks a order from savegames made with TTD(Patch) * @param packed packed order * @return unpacked order */ diff --git a/src/saveload/saveload.cpp b/src/saveload/saveload.cpp index 61474be04..1efa2eee1 100644 --- a/src/saveload/saveload.cpp +++ b/src/saveload/saveload.cpp @@ -7,7 +7,8 @@ * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see . */ -/** @file saveload.cpp +/** + * @file saveload.cpp * All actions handling saving and loading goes on in this file. The general actions * are as follows for saving a game (loading is analogous): *
    @@ -432,7 +433,8 @@ static inline size_t SlGetOffs() return _sl.offs_base - (_sl.bufe - _sl.bufp); } -/** Flush the output buffer by writing to disk with the given reader. +/** + * Flush the output buffer by writing to disk with the given reader. * If the buffer pointer has not yet been set up, set it up now. Usually * only called when the buffer is full, or there is no more data to be processed */ @@ -451,7 +453,8 @@ static void SlWriteFill() _sl.bufe = _sl.buf + _sl.bufsize; } -/** Read in a single byte from file. If the temporary buffer is full, +/** + * Read in a single byte from file. If the temporary buffer is full, * flush it to its final destination * @return return the read byte from file */ @@ -464,7 +467,8 @@ static inline byte SlReadByteInternal() /** Wrapper for SlReadByteInternal */ byte SlReadByte() {return SlReadByteInternal();} -/** Write away a single byte from memory. If the temporary buffer is full, +/** + * Write away a single byte from memory. If the temporary buffer is full, * flush it to its destination (file) * @param b the byte that is currently written */ @@ -514,7 +518,8 @@ static inline void SlWriteUint64(uint64 x) SlWriteUint32((uint32)x); } -/** Read in bytes from the file/data structure but don't do +/** + * Read in bytes from the file/data structure but don't do * anything with them, discarding them in effect * @param length The amount of bytes that is being treated this way */ @@ -1244,7 +1249,8 @@ static inline bool SlIsObjectValidInSavegame(const SaveLoad *sld) return true; } -/** Are we going to load this variable when loading a savegame or not? +/** + * Are we going to load this variable when loading a savegame or not? * @note If the variable is skipped it is skipped in the savegame * bytestream itself as well, so there is no need to skip it somewhere else */ static inline bool SlSkipVariableOnLoad(const SaveLoad *sld) @@ -2066,7 +2072,8 @@ static void SaveFileError() SaveFileDone(); } -/** We have written the whole game into memory, _memory_savegame, now find +/** + * We have written the whole game into memory, _memory_savegame, now find * and appropiate compressor and start writing to file. */ static SaveOrLoadResult SaveFileToDisk(bool threaded) diff --git a/src/saveload/saveload.h b/src/saveload/saveload.h index 32a9429e3..56e447294 100644 --- a/src/saveload/saveload.h +++ b/src/saveload/saveload.h @@ -94,7 +94,8 @@ enum ChunkType { CH_AUTO_LENGTH = 16, }; -/** VarTypes is the general bitmasked magic type that tells us +/** + * VarTypes is the general bitmasked magic type that tells us * certain characteristics about the variable it refers to. For example * SLE_FILE_* gives the size(type) as it would be in the savegame and * SLE_VAR_* the size(type) as it is in memory during runtime. These are @@ -251,7 +252,8 @@ typedef SaveLoad SaveLoadGlobVarList; #define SLEG_END() {true, SL_END, 0, 0, 0, 0, NULL} -/** Checks if the savegame is below major.minor. +/** + * Checks if the savegame is below major.minor. */ static inline bool CheckSavegameVersionOldStyle(uint16 major, byte minor) { @@ -260,7 +262,8 @@ static inline bool CheckSavegameVersionOldStyle(uint16 major, byte minor) return (_sl_version < major) || (_sl_version == major && _sl_minor_version < minor); } -/** Checks if the savegame is below version. +/** + * Checks if the savegame is below version. */ static inline bool CheckSavegameVersion(uint16 version) { @@ -268,7 +271,8 @@ static inline bool CheckSavegameVersion(uint16 version) return _sl_version < version; } -/** Checks if some version from/to combination falls within the range of the +/** + * Checks if some version from/to combination falls within the range of the * active savegame version */ static inline bool SlIsObjectCurrentlyValid(uint16 version_from, uint16 version_to) { @@ -310,7 +314,8 @@ static inline bool IsNumericType(VarType conv) return GetVarMemType(conv) <= SLE_VAR_U64; } -/** Get the address of the variable. Which one to pick depends on the object +/** + * Get the address of the variable. Which one to pick depends on the object * pointer. If it is NULL we are dealing with global variables so the address * is taken. If non-null only the offset is stored in the union and we need * to add this to the address of the object */ -- cgit v1.2.3-54-g00ecf