diff options
Diffstat (limited to 'engines/gob/save/savefile.h')
| -rw-r--r-- | engines/gob/save/savefile.h | 37 |
1 files changed, 19 insertions, 18 deletions
diff --git a/engines/gob/save/savefile.h b/engines/gob/save/savefile.h index da3696dee8..980616bb74 100644 --- a/engines/gob/save/savefile.h +++ b/engines/gob/save/savefile.h @@ -35,13 +35,14 @@ namespace Gob { class GobEngine; class Surface; -/** A class wrapping a save part header. - * - * A save part header consists of 4 fields: - * ID : The 8 character ID \0SCVMGOB - * Type : The 4 character ID for this part's type - * Version : This part's version. Each type has its own version counter - * Size : The size of the contents, i.e. excluding this header +/** + * A class wrapping a save part header. + * + * A save part header consists of 4 fields: + * ID : The 8 character ID \0SCVMGOB + * Type : The 4 character ID for this part's type + * Version : This part's version. Each type has its own version counter + * Size : The size of the contents, i.e. excluding this header */ class SaveHeader { public: @@ -186,13 +187,13 @@ public: static const uint32 kVersion = 1; static const uint32 kID = MKID_BE('INFO'); - /** The constructor. - * - * @param descMaxLength The maximal number of bytes that fit into the description. - * @param gameID An ID for the game (Gob1, Gob2, Gob3, ...). - * @param gameVersion An ID for game specific versioning - * @param endian Endianness of the platform the game originally ran on. - * @param varCount The number of script variables. + /** + * The constructor. + * @param descMaxLength The maximal number of bytes that fit into the description. + * @param gameID An ID for the game (Gob1, Gob2, Gob3, ...). + * @param gameVersion An ID for game specific versioning + * @param endian Endianness of the platform the game originally ran on. + * @param varCount The number of script variables. */ SavePartInfo(uint32 descMaxLength, uint32 gameID, uint32 gameVersion, byte endian, uint32 varCount); @@ -228,10 +229,10 @@ public: static const uint32 kVersion = 1; static const uint32 kID = MKID_BE('CONT'); - /** The constructor. - * - * @param partCount The number parts this container shall hold. - * @param slot The save slot this save's for. + /** + * The constructor. + * @param partCount The number parts this container shall hold. + * @param slot The save slot this save's for. */ SaveContainer(uint32 partCount, uint32 slot); ~SaveContainer(); |