diff options
Diffstat (limited to 'engines')
| -rw-r--r-- | engines/zvision/singleValueContainer.h | 36 | ||||
| -rw-r--r-- | engines/zvision/utility.h | 6 | ||||
| -rw-r--r-- | engines/zvision/zfsArchive.h | 15 |
3 files changed, 29 insertions, 28 deletions
diff --git a/engines/zvision/singleValueContainer.h b/engines/zvision/singleValueContainer.h index 3c24cc07f0..49c7267f77 100644 --- a/engines/zvision/singleValueContainer.h +++ b/engines/zvision/singleValueContainer.h @@ -95,64 +95,64 @@ public: * Retrieve a bool from the container. If the container is not storing a * bool, this will return false and display a warning(). * - * @param returnValue Pointer to where you want the value stored - * @return Value indicating whether the value assignment was successful + * @param returnValue Pointer to where you want the value stored + * @return Value indicating whether the value assignment was successful */ bool getBoolValue(bool *returnValue) const; /** * Retrieve a byte from the container. If the container is not storing a * byte, this will return false and display a warning(). * - * @param returnValue Pointer to where you want the value stored - * @return Value indicating whether the value assignment was successful + * @param returnValue Pointer to where you want the value stored + * @return Value indicating whether the value assignment was successful */ bool getByteValue(byte *returnValue) const; /** * Retrieve an int16 from the container. If the container is not storing an * int16, this will return false and display a warning(). * - * @param returnValue Pointer to where you want the value stored - * @return Value indicating whether the value assignment was successful + * @param returnValue Pointer to where you want the value stored + * @return Value indicating whether the value assignment was successful */ bool getInt16Value(int16 *returnValue) const; /** * Retrieve a uint16 from the container. If the container is not storing a * uint16, this will return false and display a warning(). * - * @param returnValue Pointer to where you want the value stored - * @return Value indicating whether the value assignment was successful + * @param returnValue Pointer to where you want the value stored + * @return Value indicating whether the value assignment was successful */ bool getUInt16Value(uint16 *returnValue) const; /** * Retrieve an int32 from the container. If the container is not storing an * int32, this will return false and display a warning(). * - * @param returnValue Pointer to where you want the value stored - * @return Value indicating whether the value assignment was successful + * @param returnValue Pointer to where you want the value stored + * @return Value indicating whether the value assignment was successful */ bool getInt32Value(int32 *returnValue) const; /** * Retrieve a uint32 from the container. If the container is not storing a * uint32, this will return false and display a warning(). * - * @param returnValue Pointer to where you want the value stored - * @return Value indicating whether the value assignment was successful + * @param returnValue Pointer to where you want the value stored + * @return Value indicating whether the value assignment was successful */ bool getUInt32Value(uint32 *returnValue) const; /** * Retrieve a float from the container. If the container is not storing a * float, this will return false and display a warning(). * - * @param returnValue Pointer to where you want the value stored - * @return Value indicating whether the value assignment was successful + * @param returnValue Pointer to where you want the value stored + * @return Value indicating whether the value assignment was successful */ bool getFloatValue(float *returnValue) const; /** * Retrieve a double from the container. If the container is not storing a * double, this will return false and display a warning(). * - * @param returnValue Pointer to where you want the value stored - * @return Value indicating whether the value assignment was successful + * @param returnValue Pointer to where you want the value stored + * @return Value indicating whether the value assignment was successful */ bool getDoubleValue(double *returnValue) const; /** @@ -163,8 +163,8 @@ public: * Common::String::operator=(char *) to do the assigment, which uses both * strlen() AND memmove(). * - * @param returnValue Pointer to where you want the value stored - * @return Value indicating whether the value assignment was successful + * @param returnValue Pointer to where you want the value stored + * @return Value indicating whether the value assignment was successful */ bool getStringValue(Common::String *returnValue) const; diff --git a/engines/zvision/utility.h b/engines/zvision/utility.h index 9fade107f5..4d124509ba 100644 --- a/engines/zvision/utility.h +++ b/engines/zvision/utility.h @@ -33,8 +33,8 @@ namespace ZVision { * Opens the sourceFile utilizing Common::File (aka SearchMan) and writes the * contents to destFile. destFile is created in the working directory * - * @param sourceFile The 'file' you want the contents of - * @param destFile The name of the file where the content will be written to + * @param sourceFile The 'file' you want the contents of + * @param destFile The name of the file where the content will be written to */ void writeFileContentsToFile(Common::String sourceFile, Common::String destFile) { Common::File f; @@ -57,7 +57,7 @@ void writeFileContentsToFile(Common::String sourceFile, Common::String destFile) * Then removes any trailing and leading 'whitespace' using String::trim() * Note: String::trim uses isspace() to determine what is whitespace and what is not. * - * @param string The string to modify. It is modified in place + * @param string The string to modify. It is modified in place */ void trimCommentsAndWhiteSpace(Common::String &string) { for (int i = string.size(); i >= 0; --i) { diff --git a/engines/zvision/zfsArchive.h b/engines/zvision/zfsArchive.h index 60292f865e..ccdf192571 100644 --- a/engines/zvision/zfsArchive.h +++ b/engines/zvision/zfsArchive.h @@ -67,7 +67,7 @@ public: * Add all members of the Archive to list. * Must only append to list, and not remove elements from it. * - * @return the number of names added to list + * @return The number of names added to list */ int listMembers(Common::ArchiveMemberList &list) const; @@ -79,7 +79,8 @@ public: /** * Create a stream bound to a member with the specified name in the * archive. If no member with this name exists, 0 is returned. - * @return the newly created input stream + * + * @return The newly created input stream */ Common::SeekableReadStream *createReadStreamForMember(const Common::String &name) const; @@ -92,7 +93,7 @@ private: * Parses the zfs file into file entry headers that can be used later * to get the entry data. * - * @param stream The contents of the zfs file + * @param stream The contents of the zfs file */ void readHeaders(Common::SeekableReadStream *stream); @@ -100,8 +101,8 @@ private: * Entry names are contained within a 16 byte block. This reads the block * and converts it the name to a Common::String * - * @param stream The zfs file stream - * @return The entry file name + * @param stream The zfs file stream + * @return The entry file name */ Common::String readEntryName(Common::SeekableReadStream *stream) const; @@ -109,8 +110,8 @@ private: * ZFS file entries can be encrypted using XOR encoding. This method * decodes the buffer in place using the supplied xorKey. * - * @param buffer The data to decode - * @param length Length of buffer + * @param buffer The data to decode + * @param length Length of buffer */ void unXor(byte *buffer, int length, const byte *xorKey) const; }; |