[Scummvm-cvs-logs] scummvm master -> ec634ea07c24143e3e1736fec8934d120018fbd6
lordhoto
lordhoto at gmail.com
Sat Aug 30 14:15:03 CEST 2014
This automated email contains information about 7 new commits which have been
pushed to the 'scummvm' repo located at https://github.com/scummvm/scummvm .
Summary:
0593c2eab2 GRAPHICS: Fix some Doxygen comments that seem wrong.
b7c5ce879f COMMON: Fix some Doxygen comments that seem wrong.
1506f6049e BACKENDS: Fix some Doxygen comments that seem wrong.
2fa1340438 ENGINES: Fix some Doxygen comments that seem wrong.
e34a8fe9eb GUI: Fix some Doxygen comments that seem wrong.
06c3a73289 AUDIO: Fix some Doxygen comments that seem wrong.
ec634ea07c Merge pull request #495 from somaen/docuFix
Commit: 0593c2eab29e61692738dd8d88cfa88501803f0d
https://github.com/scummvm/scummvm/commit/0593c2eab29e61692738dd8d88cfa88501803f0d
Author: Einar Johan Trøan Sømåen (einarjohants at gmail.com)
Date: 2014-08-29T03:26:48+02:00
Commit Message:
GRAPHICS: Fix some Doxygen comments that seem wrong.
Changed paths:
graphics/VectorRenderer.h
graphics/conversion.h
graphics/fontman.h
graphics/surface.h
graphics/transform_tools.h
diff --git a/graphics/VectorRenderer.h b/graphics/VectorRenderer.h
index 8e1c5e9..703da68 100644
--- a/graphics/VectorRenderer.h
+++ b/graphics/VectorRenderer.h
@@ -182,7 +182,7 @@ public:
* @param x Horizontal (X) coordinate for the top left corner of the triangle
* @param y Vertical (Y) coordinate for the top left corner of the triangle
* @param base Width of the base of the triangle
- * @param h Height of the triangle
+ * @param height Height of the triangle
* @param orient Orientation of the triangle.
*/
virtual void drawTriangle(int x, int y, int base, int height, TriangleOrientation orient) = 0;
@@ -276,8 +276,6 @@ public:
/**
* Fills the active surface with the specified fg/bg color or the active gradient.
* Defaults to using the active Foreground color for filling.
- *
- * @param mode Fill mode (bg, fg or gradient) used to fill the surface
*/
virtual void fillSurface() = 0;
diff --git a/graphics/conversion.h b/graphics/conversion.h
index 33d57f7..8ca529a 100644
--- a/graphics/conversion.h
+++ b/graphics/conversion.h
@@ -48,10 +48,10 @@ inline static void RGB2YUV(byte r, byte g, byte b, byte &y, byte &u, byte &v) {
/**
* Blits a rectangle from one graphical format to another.
*
- * @param dstbuf the buffer which will recieve the converted graphics data
- * @param srcbuf the buffer containing the original graphics data
- * @param dstpitch width in bytes of one full line of the dest buffer
- * @param srcpitch width in bytes of one full line of the source buffer
+ * @param dst the buffer which will recieve the converted graphics data
+ * @param src the buffer containing the original graphics data
+ * @param dstPitch width in bytes of one full line of the dest buffer
+ * @param srcPitch width in bytes of one full line of the source buffer
* @param w the width of the graphics data
* @param h the height of the graphics data
* @param dstFmt the desired pixel format
diff --git a/graphics/fontman.h b/graphics/fontman.h
index b3de92f..515b157 100644
--- a/graphics/fontman.h
+++ b/graphics/fontman.h
@@ -75,7 +75,6 @@ public:
* Associates a BDF font object with an 'usage'. This is useful for platforms
* with a screen DPI much larger than a regular desktop workstation.
*
- * @param name the name of the font
* @param font the font object
* @return true on success, false on failure
*/
diff --git a/graphics/surface.h b/graphics/surface.h
index d083449..ad15944 100644
--- a/graphics/surface.h
+++ b/graphics/surface.h
@@ -214,7 +214,7 @@ public:
* of buffer must match the pixel format of the Surface.
*
* @param buffer The buffer containing the graphics data source
- * @param pitch The pitch of the buffer (number of bytes in a scanline)
+ * @param srcPitch The pitch of the buffer (number of bytes in a scanline)
* @param destX The x coordinate of the destination rectangle
* @param destY The y coordinate of the destination rectangle
* @param width The width of the destination rectangle
@@ -228,8 +228,7 @@ public:
* @param srcSurface The source of the bitmap data
* @param destX The x coordinate of the destination rectangle
* @param destY The y coordinate of the destination rectangle
- * @param subRect The subRect of surface to be blitted
- * @return
+ * @param subRect The subRect of surface to be blitted
*/
void copyRectToSurface(const Graphics::Surface &srcSurface, int destX, int destY, const Common::Rect subRect);
diff --git a/graphics/transform_tools.h b/graphics/transform_tools.h
index c618f7c..a51c8ee 100644
--- a/graphics/transform_tools.h
+++ b/graphics/transform_tools.h
@@ -57,15 +57,15 @@ class TransformTools {
public:
/**
* Basic transform (scale + rotate) for a single point
+ * @param point the point on which the transform is to be applied
+ * @param rotate the angle in degrees
+ * @param zoom zoom x,y in percent
+ * @param mirrorX flip along the vertical axis?
+ * @param mirrorY flip along the horizontal axis?
*/
static FloatPoint transformPoint(FloatPoint point, const float rotate, const Common::Point &zoom, const bool mirrorX = false, const bool mirrorY = false);
/**
- * @param &point the point on which the transform is to be applied
- * @param rotate the angle in degrees
- * @param &zoom zoom x,y in percent
- * @param mirrorX flip along the vertical axis?
- * @param mirrorY flip along the horizontal axis?
* @return the smallest rect that can contain the transformed sprite
* and, as a side-effect, "newHotspot" will tell you where the hotspot will
* have ended up in the new rect, for centering.
Commit: b7c5ce879fc386d815654fb128bf1c9a5973eefb
https://github.com/scummvm/scummvm/commit/b7c5ce879fc386d815654fb128bf1c9a5973eefb
Author: Einar Johan Trøan Sømåen (einarjohants at gmail.com)
Date: 2014-08-29T03:28:00+02:00
Commit Message:
COMMON: Fix some Doxygen comments that seem wrong.
Changed paths:
common/dcl.cpp
common/events.h
common/file.h
common/localization.h
common/macresman.h
common/quicktime.h
common/str.h
common/stream.h
common/zlib.h
diff --git a/common/dcl.cpp b/common/dcl.cpp
index bb4e283..2f4cded 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 488d586..484564e 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 29f12b2..c055acc 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 096c5e9..5180327 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 3735457..43ec8d8 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 f5fd578..f74d1ed 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 a2451f2..dede87a 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 238844a..2702068 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 e2936a3..5adba64 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.
*/
Commit: 1506f6049e6a7ad7c9aedd2a48ffd0d360783d96
https://github.com/scummvm/scummvm/commit/1506f6049e6a7ad7c9aedd2a48ffd0d360783d96
Author: Einar Johan Trøan Sømåen (einarjohants at gmail.com)
Date: 2014-08-29T03:28:26+02:00
Commit Message:
BACKENDS: Fix some Doxygen comments that seem wrong.
Changed paths:
backends/audiocd/audiocd.h
backends/graphics/opengl/opengl-graphics.h
diff --git a/backends/audiocd/audiocd.h b/backends/audiocd/audiocd.h
index db9a155..6eae8e0 100644
--- a/backends/audiocd/audiocd.h
+++ b/backends/audiocd/audiocd.h
@@ -58,8 +58,8 @@ public:
/**
* Start audio CD playback
* @param track the track to play.
- * @param num_loops how often playback should be repeated (-1 = infinitely often).
- * @param start_frame the frame at which playback should start (75 frames = 1 second).
+ * @param numLoops how often playback should be repeated (-1 = infinitely often).
+ * @param startFrame the frame at which playback should start (75 frames = 1 second).
* @param duration the number of frames to play.
* @param only_emulate determines if the track should be emulated only
*/
diff --git a/backends/graphics/opengl/opengl-graphics.h b/backends/graphics/opengl/opengl-graphics.h
index d16f92d..dde2153 100644
--- a/backends/graphics/opengl/opengl-graphics.h
+++ b/backends/graphics/opengl/opengl-graphics.h
@@ -131,7 +131,7 @@ protected:
*
* @param defaultFormat The new default format for the game screen
* (this is used for the CLUT8 game screens).
- * @param defaultFromatAlpha The new default format with an alpha channel
+ * @param defaultFormatAlpha The new default format with an alpha channel
* (this is used for the overlay and cursor).
*/
void notifyContextCreate(const Graphics::PixelFormat &defaultFormat, const Graphics::PixelFormat &defaultFormatAlpha);
Commit: 2fa13404380ddb1f9fe364d78d84f2b9309a44b7
https://github.com/scummvm/scummvm/commit/2fa13404380ddb1f9fe364d78d84f2b9309a44b7
Author: Einar Johan Trøan Sømåen (einarjohants at gmail.com)
Date: 2014-08-29T03:28:43+02:00
Commit Message:
ENGINES: Fix some Doxygen comments that seem wrong.
Changed paths:
engines/savestate.h
engines/wintermute/base/gfx/base_renderer.h
diff --git a/engines/savestate.h b/engines/savestate.h
index 970e014..54eff0f 100644
--- a/engines/savestate.h
+++ b/engines/savestate.h
@@ -140,7 +140,7 @@ public:
* Sets the time the game was played before the save state was created.
*
* @param hours How many hours the user played the game so far.
- * @param min How many minutes the user played the game so far.
+ * @param minutes How many minutes the user played the game so far.
*/
void setPlayTime(int hours, int minutes);
diff --git a/engines/wintermute/base/gfx/base_renderer.h b/engines/wintermute/base/gfx/base_renderer.h
index 42ff2cb..6b1a4f9 100644
--- a/engines/wintermute/base/gfx/base_renderer.h
+++ b/engines/wintermute/base/gfx/base_renderer.h
@@ -72,7 +72,6 @@ public:
* Fade the screen to black
*
* @param alpha amount to fade by (alpha value of black)
- * @return
*/
virtual void fade(uint16 alpha) = 0;
/**
Commit: e34a8fe9eb3b53e00a4be0fde51929b853854c42
https://github.com/scummvm/scummvm/commit/e34a8fe9eb3b53e00a4be0fde51929b853854c42
Author: Einar Johan Trøan Sømåen (einarjohants at gmail.com)
Date: 2014-08-29T03:28:59+02:00
Commit Message:
GUI: Fix some Doxygen comments that seem wrong.
Changed paths:
gui/ThemeEngine.h
gui/debugger.h
diff --git a/gui/ThemeEngine.h b/gui/ThemeEngine.h
index 4dffb13..68be2e0 100644
--- a/gui/ThemeEngine.h
+++ b/gui/ThemeEngine.h
@@ -433,7 +433,7 @@ public:
* Interface for the ThemeParser class: Loads a font to use on the GUI from the given
* filename.
*
- * @param fextId Identifier name for the font.
+ * @param textId Identifier name for the font.
* @param file Filename of the non-scalable font version.
* @param scalableFile Filename of the scalable version. (Optional)
* @param pointsize Point size for the scalable font. (Optional)
diff --git a/gui/debugger.h b/gui/debugger.h
index 8c7481b..175eb33 100644
--- a/gui/debugger.h
+++ b/gui/debugger.h
@@ -103,7 +103,7 @@ private:
* @param varname the identifier with which the user may access the variable
* @param variable pointer to the actual storage of the variable
* @param type the type of the variable (byte, int, bool, ...)
- * @paral arraySize for type DVAR_INTARRAY this specifies the size of the array
+ * @param arraySize for type DVAR_INTARRAY this specifies the size of the array
*/
void registerVar(const Common::String &varname, void *variable, VarType type, int arraySize);
Commit: 06c3a7328964d39cbafab3867b0f590f9da4b161
https://github.com/scummvm/scummvm/commit/06c3a7328964d39cbafab3867b0f590f9da4b161
Author: Einar Johan Trøan Sømåen (einarjohants at gmail.com)
Date: 2014-08-29T03:29:13+02:00
Commit Message:
AUDIO: Fix some Doxygen comments that seem wrong.
Changed paths:
audio/audiostream.h
diff --git a/audio/audiostream.h b/audio/audiostream.h
index 5202a47..347a37b 100644
--- a/audio/audiostream.h
+++ b/audio/audiostream.h
@@ -125,8 +125,6 @@ public:
/**
* Returns number of loops the stream has played.
- *
- * @param numLoops number of loops to play, 0 - infinite
*/
uint getCompleteIterations() const { return _completeIterations; }
private:
Commit: ec634ea07c24143e3e1736fec8934d120018fbd6
https://github.com/scummvm/scummvm/commit/ec634ea07c24143e3e1736fec8934d120018fbd6
Author: Johannes Schickel (lordhoto at gmail.com)
Date: 2014-08-30T14:14:31+02:00
Commit Message:
Merge pull request #495 from somaen/docuFix
Doxygen-fixes
Changed paths:
audio/audiostream.h
backends/audiocd/audiocd.h
backends/graphics/opengl/opengl-graphics.h
common/dcl.cpp
common/events.h
common/file.h
common/localization.h
common/macresman.h
common/quicktime.h
common/str.h
common/stream.h
common/zlib.h
engines/savestate.h
engines/wintermute/base/gfx/base_renderer.h
graphics/VectorRenderer.h
graphics/conversion.h
graphics/fontman.h
graphics/surface.h
graphics/transform_tools.h
gui/ThemeEngine.h
gui/debugger.h
More information about the Scummvm-git-logs
mailing list