aboutsummaryrefslogtreecommitdiff
path: root/common
diff options
context:
space:
mode:
authorEinar Johan Trøan Sømåen2014-08-29 03:28:00 +0200
committerEinar Johan Trøan Sømåen2014-08-29 03:28:00 +0200
commitb7c5ce879fc386d815654fb128bf1c9a5973eefb (patch)
tree2c2521cb3022aa9a2120b18f3a2ccfaaebc75235 /common
parent0593c2eab29e61692738dd8d88cfa88501803f0d (diff)
downloadscummvm-rg350-b7c5ce879fc386d815654fb128bf1c9a5973eefb.tar.gz
scummvm-rg350-b7c5ce879fc386d815654fb128bf1c9a5973eefb.tar.bz2
scummvm-rg350-b7c5ce879fc386d815654fb128bf1c9a5973eefb.zip
COMMON: Fix some Doxygen comments that seem wrong.
Diffstat (limited to 'common')
-rw-r--r--common/dcl.cpp3
-rw-r--r--common/events.h2
-rw-r--r--common/file.h3
-rw-r--r--common/localization.h4
-rw-r--r--common/macresman.h6
-rw-r--r--common/quicktime.h2
-rw-r--r--common/str.h1
-rw-r--r--common/stream.h2
-rw-r--r--common/zlib.h4
9 files changed, 12 insertions, 15 deletions
diff --git a/common/dcl.cpp b/common/dcl.cpp
index bb4e283de5..2f4cdeda6b 100644
--- a/common/dcl.cpp
+++ b/common/dcl.cpp
@@ -38,8 +38,7 @@ protected:
* @param src source stream to read from
* @param dest destination stream to write to
* @param nPacked size of packed data
- * @param nUnpacket size of unpacked data
- * @return 0 on success, non-zero on error
+ * @param nUnpacked size of unpacked data
*/
void init(ReadStream *src, byte *dest, uint32 nPacked, uint32 nUnpacked);
diff --git a/common/events.h b/common/events.h
index 488d586b3f..484564e3db 100644
--- a/common/events.h
+++ b/common/events.h
@@ -317,7 +317,7 @@ public:
/**
* Registers a new EventObserver with the Dispatcher.
*
- * @param listenPools if set, then all pollEvent() calls are passed to observer
+ * @param listenPolls if set, then all pollEvent() calls are passed to observer
* currently it is used by keyMapper
*/
void registerObserver(EventObserver *obs, uint priority, bool autoFree, bool listenPolls = false);
diff --git a/common/file.h b/common/file.h
index 29f12b255d..c055acc57d 100644
--- a/common/file.h
+++ b/common/file.h
@@ -82,8 +82,7 @@ public:
* those cases gracefully.
* @note Must not be called if this file already is open (i.e. if isOpen returns true).
*
- * @param filename the name of the file to open
- * @param archive the archive in which to search for the file
+ * @param node the node to consider.
* @return true if file was opened successfully, false otherwise
*/
virtual bool open(const FSNode &node);
diff --git a/common/localization.h b/common/localization.h
index 096c5e95f5..51803279e7 100644
--- a/common/localization.h
+++ b/common/localization.h
@@ -35,7 +35,7 @@ namespace Common {
*
* @param id Language id
* @param keyYes Key code for yes
- * @param keyYes Key code for no
+ * @param keyNo Key code for no
*/
void getLanguageYesNo(Language id, KeyCode &keyYes, KeyCode &keyNo);
@@ -44,7 +44,7 @@ void getLanguageYesNo(Language id, KeyCode &keyYes, KeyCode &keyNo);
* language of the ScummVM GUI.
*
* @param keyYes Key code for yes
- * @param keyYes Key code for no
+ * @param keyNo Key code for no
*/
void getLanguageYesNo(KeyCode &keyYes, KeyCode &keyNo);
diff --git a/common/macresman.h b/common/macresman.h
index 373545795e..43ec8d8e2c 100644
--- a/common/macresman.h
+++ b/common/macresman.h
@@ -58,7 +58,7 @@ public:
* This uses SearchMan to find the data/resource forks. This should only be used
* from inside an engine.
*
- * @param filename The base file name of the file
+ * @param fileName The base file name of the file
* @note This will check for the raw resource fork, MacBinary, and AppleDouble formats.
* @return True on success
*/
@@ -68,7 +68,7 @@ public:
* Open a Mac data/resource fork pair.
*
* @param path The path that holds the forks
- * @param filename The base file name of the file
+ * @param fileName The base file name of the file
* @note This will check for the raw resource fork, MacBinary, and AppleDouble formats.
* @return True on success
*/
@@ -76,7 +76,7 @@ public:
/**
* See if a Mac data/resource fork pair exists.
- * @param filename The base file name of the file
+ * @param fileName The base file name of the file
* @return True if either a data fork or resource fork with this name exists
*/
static bool exists(const String &fileName);
diff --git a/common/quicktime.h b/common/quicktime.h
index f5fd578e3a..f74d1ed0d9 100644
--- a/common/quicktime.h
+++ b/common/quicktime.h
@@ -74,7 +74,7 @@ public:
/**
* Set the beginning offset of the video so we can modify the offsets in the stco
* atom of videos inside the Mohawk archives
- * @param the beginning offset of the video
+ * @param offset the beginning offset of the video
*/
void setChunkBeginOffset(uint32 offset) { _beginOffset = offset; }
diff --git a/common/str.h b/common/str.h
index a2451f2f69..dede87a005 100644
--- a/common/str.h
+++ b/common/str.h
@@ -166,7 +166,6 @@ public:
* String: monkey.s101 Pattern: monkey.s* => true
* String: monkey.s99 Pattern: monkey.s*1 => false
*
- * @param str Text to be matched against the given pattern.
* @param pat Glob pattern.
* @param ignoreCase Whether to ignore the case when doing pattern match
* @param pathMode Whether to use path mode, i.e., whether slashes must be matched explicitly.
diff --git a/common/stream.h b/common/stream.h
index 238844a860..2702068cf3 100644
--- a/common/stream.h
+++ b/common/stream.h
@@ -390,7 +390,7 @@ public:
* @note This methods is closely modeled after the standard fgets()
* function from stdio.h.
*
- * @param buf the buffer to store into
+ * @param s the buffer to store into
* @param bufSize the size of the buffer
* @return a pointer to the read string, or NULL if an error occurred
*/
diff --git a/common/zlib.h b/common/zlib.h
index e2936a334a..5adba64076 100644
--- a/common/zlib.h
+++ b/common/zlib.h
@@ -68,7 +68,7 @@ bool uncompress(byte *dst, unsigned long *dstLen, const byte *src, unsigned long
* @param dst the buffer to store into.
* @param dstLen the size of the destination buffer.
* @param src the data to be decompressed.
- * @param dstLen the size of the compressed data.
+ * @param srcLen the size of the compressed data.
* @param dict (optional) a decompress dictionary.
* @param dictLen (optional) the size of the dictionary.
* Mandatory if dict is not 0.
@@ -90,7 +90,7 @@ bool inflateZlibHeaderless(byte *dst, uint dstLen, const byte *src, uint srcLen,
* @param dst the buffer to store into.
* @param dstLen the size of the destination buffer.
* @param src the data to be decompressed.
- * @param dstLen the size of the compressed data.
+ * @param srcLen the size of the compressed data.
*
* @return true on success (Z_OK or Z_STREAM_END), false otherwise.
*/