Fixed Doxygen warnings.
authorPhilipp Wiesemann <philipp.wiesemann@arcor.de>
Sat, 18 May 2013 14:48:19 +0200
changeset 7188 20bd120bf7e4
parent 7187 76d08a13a0f0
child 7189 414be1d64060
Fixed Doxygen warnings.
include/SDL_events.h
include/SDL_messagebox.h
include/SDL_render.h
include/SDL_surface.h
include/SDL_video.h
--- a/include/SDL_events.h	Sat May 18 14:04:37 2013 +0200
+++ b/include/SDL_events.h	Sat May 18 14:48:19 2013 +0200
@@ -581,6 +581,7 @@
  *  
  *  \param event If not NULL, the next event is removed from the queue and 
  *               stored in that area.
+ *  \param timeout The timeout (in milliseconds) to wait for next event.
  */
 extern DECLSPEC int SDLCALL SDL_WaitEventTimeout(SDL_Event * event,
                                                  int timeout);
--- a/include/SDL_messagebox.h	Sat May 18 14:04:37 2013 +0200
+++ b/include/SDL_messagebox.h	Sat May 18 14:48:19 2013 +0200
@@ -108,6 +108,7 @@
  *  \brief Create a modal message box.
  *
  *  \param messageboxdata The SDL_MessageBoxData structure with title, text, etc.
+ *  \param buttonid The pointer to which user id of hit button should be copied.
  *
  *  \return -1 on error, otherwise 0 and buttonid contains user id of button
  *          hit or -1 if dialog was closed.
--- a/include/SDL_render.h	Sat May 18 14:04:37 2013 +0200
+++ b/include/SDL_render.h	Sat May 18 14:48:19 2013 +0200
@@ -216,6 +216,7 @@
 /**
  *  \brief Create a texture for a rendering context.
  *  
+ *  \param renderer The renderer.
  *  \param format The format of the texture.
  *  \param access One of the enumerated values in ::SDL_TextureAccess.
  *  \param w      The width of the texture in pixels.
@@ -237,6 +238,7 @@
 /**
  *  \brief Create a texture from an existing surface.
  *  
+ *  \param renderer The renderer.
  *  \param surface The surface containing pixel data used to fill the texture.
  *  
  *  \return The created texture is returned, or 0 on error.
@@ -410,6 +412,7 @@
 /**
  * \brief Set a texture as the current rendering target.
  *
+ * \param renderer The renderer.
  * \param texture The targeted texture, which must be created with the SDL_TEXTUREACCESS_TARGET flag, or NULL for the default render target
  *
  * \return 0 on success, or -1 on error
@@ -431,6 +434,7 @@
 /**
  *  \brief Set device independent resolution for rendering
  *
+ *  \param renderer The renderer for which resolution should be set.
  *  \param w      The width of the logical resolution
  *  \param h      The height of the logical resolution
  *
@@ -455,6 +459,7 @@
 /**
  *  \brief Get device independent resolution for rendering
  *
+ *  \param renderer The renderer from which resolution should be queried.
  *  \param w      A pointer filled with the width of the logical resolution
  *  \param h      A pointer filled with the height of the logical resolution
  *
@@ -465,6 +470,7 @@
 /**
  *  \brief Set the drawing area for rendering on the current target.
  *
+ *  \param renderer The renderer for which the drawing area should be set.
  *  \param rect The rectangle representing the drawing area, or NULL to set the viewport to the entire target.
  *
  *  The x,y of the viewport rect represents the origin for rendering.
@@ -491,6 +497,7 @@
 /**
  *  \brief Set the clip rectangle for the current target.
  *  
+ *  \param renderer The renderer for which clip rectangle should be set.
  *  \param rect   A pointer to the rectangle to set as the clip rectangle, or
  *                NULL to disable clipping.
  *
@@ -504,6 +511,7 @@
 /**
  *  \brief Get the clip rectangle for the current target.
  *  
+ *  \param renderer The renderer from which clip rectangle should be queried.
  *  \param rect   A pointer filled in with the current clip rectangle, or
  *                an empty rectangle if clipping is disabled.
  *
@@ -515,6 +523,7 @@
 /**
  *  \brief Set the drawing scale for rendering on the current target.
  *
+ *  \param renderer The renderer for which the drawing scale should be set.
  *  \param scaleX The horizontal scaling factor
  *  \param scaleY The vertical scaling factor
  *
@@ -535,6 +544,7 @@
 /**
  *  \brief Get the drawing scale for the current target.
  *
+ *  \param renderer The renderer from which drawing scale should be queried.
  *  \param scaleX A pointer filled in with the horizontal scaling factor
  *  \param scaleY A pointer filled in with the vertical scaling factor
  *
@@ -546,6 +556,7 @@
 /**
  *  \brief Set the color used for drawing operations (Rect, Line and Clear).
  *  
+ *  \param renderer The renderer for which drawing color should be set.
  *  \param r The red value used to draw on the rendering target.
  *  \param g The green value used to draw on the rendering target.
  *  \param b The blue value used to draw on the rendering target.
@@ -561,6 +572,7 @@
 /**
  *  \brief Get the color used for drawing operations (Rect, Line and Clear).
  *  
+ *  \param renderer The renderer from which drawing color should be queried.
  *  \param r A pointer to the red value used to draw on the rendering target.
  *  \param g A pointer to the green value used to draw on the rendering target.
  *  \param b A pointer to the blue value used to draw on the rendering target.
@@ -576,6 +588,7 @@
 /**
  *  \brief Set the blend mode used for drawing operations (Fill and Line).
  *  
+ *  \param renderer The renderer for which blend mode should be set.
  *  \param blendMode ::SDL_BlendMode to use for blending.
  *  
  *  \return 0 on success, or -1 on error
@@ -591,6 +604,7 @@
 /**
  *  \brief Get the blend mode used for drawing operations.
  *  
+ *  \param renderer The renderer from which blend mode should be queried.
  *  \param blendMode A pointer filled in with the current blend mode.
  *  
  *  \return 0 on success, or -1 on error
@@ -612,6 +626,7 @@
 /**
  *  \brief Draw a point on the current rendering target.
  *  
+ *  \param renderer The renderer which should draw a point.
  *  \param x The x coordinate of the point.
  *  \param y The y coordinate of the point.
  *  
@@ -623,6 +638,7 @@
 /**
  *  \brief Draw multiple points on the current rendering target.
  *  
+ *  \param renderer The renderer which should draw multiple points.
  *  \param points The points to draw
  *  \param count The number of points to draw
  *  
@@ -635,6 +651,7 @@
 /**
  *  \brief Draw a line on the current rendering target.
  *  
+ *  \param renderer The renderer which should draw a line.
  *  \param x1 The x coordinate of the start point.
  *  \param y1 The y coordinate of the start point.
  *  \param x2 The x coordinate of the end point.
@@ -648,6 +665,7 @@
 /**
  *  \brief Draw a series of connected lines on the current rendering target.
  *  
+ *  \param renderer The renderer which should draw multiple lines.
  *  \param points The points along the lines
  *  \param count The number of points, drawing count-1 lines
  *  
@@ -660,6 +678,7 @@
 /**
  *  \brief Draw a rectangle on the current rendering target.
  *  
+ *  \param renderer The renderer which should draw a rectangle.
  *  \param rect A pointer to the destination rectangle, or NULL to outline the entire rendering target.
  *  
  *  \return 0 on success, or -1 on error
@@ -670,6 +689,7 @@
 /**
  *  \brief Draw some number of rectangles on the current rendering target.
  *  
+ *  \param renderer The renderer which should draw multiple rectangles.
  *  \param rects A pointer to an array of destination rectangles.
  *  \param count The number of rectangles.
  *  
@@ -682,6 +702,7 @@
 /**
  *  \brief Fill a rectangle on the current rendering target with the drawing color.
  *  
+ *  \param renderer The renderer which should fill a rectangle.
  *  \param rect A pointer to the destination rectangle, or NULL for the entire 
  *              rendering target.
  *  
@@ -693,6 +714,7 @@
 /**
  *  \brief Fill some number of rectangles on the current rendering target with the drawing color.
  *  
+ *  \param renderer The renderer which should fill multiple rectangles.
  *  \param rects A pointer to an array of destination rectangles.
  *  \param count The number of rectangles.
  *  
@@ -705,6 +727,7 @@
 /**
  *  \brief Copy a portion of the texture to the current rendering target.
  *  
+ *  \param renderer The renderer which should copy parts of a texture.
  *  \param texture The source texture.
  *  \param srcrect   A pointer to the source rectangle, or NULL for the entire 
  *                   texture.
@@ -721,6 +744,7 @@
 /**
  *  \brief Copy a portion of the source texture to the current rendering target, rotating it by angle around the given center 
  *
+ *  \param renderer The renderer which should copy parts of a texture.
  *  \param texture The source texture.
  *  \param srcrect   A pointer to the source rectangle, or NULL for the entire
  *                   texture.
@@ -743,6 +767,7 @@
 /**
  *  \brief Read pixels from the current rendering target.
  *  
+ *  \param renderer The renderer from which pixels should be read.
  *  \param rect   A pointer to the rectangle to read, or NULL for the entire 
  *                render target.
  *  \param format The desired format of the pixel data, or 0 to use the format
--- a/include/SDL_surface.h	Sat May 18 14:04:37 2013 +0200
+++ b/include/SDL_surface.h	Sat May 18 14:48:19 2013 +0200
@@ -109,6 +109,13 @@
  *  If the function runs out of memory, it will return NULL.
  *  
  *  \param flags The \c flags are obsolete and should be set to 0.
+ *  \param width The width in pixels of the surface to create.
+ *  \param height The height in pixels of the surface to create.
+ *  \param depth The depth in bits of the surface to create.
+ *  \param Rmask The red mask of the surface to create.
+ *  \param Gmask The green mask of the surface to create.
+ *  \param Bmask The blue mask of the surface to create.
+ *  \param Amask The alpha mask of the surface to create.
  */
 extern DECLSPEC SDL_Surface *SDLCALL SDL_CreateRGBSurface
     (Uint32 flags, int width, int height, int depth,
--- a/include/SDL_video.h	Sat May 18 14:04:37 2013 +0200
+++ b/include/SDL_video.h	Sat May 18 14:48:19 2013 +0200
@@ -323,6 +323,7 @@
 /**
  *  \brief Get the closest match to the requested display mode.
  *  
+ *  \param displayIndex The index of display from which mode should be queried.
  *  \param mode The desired display mode
  *  \param closest A pointer to a display mode to be filled in with the closest 
  *                 match of the available display modes.
@@ -356,6 +357,7 @@
  *  By default the window's dimensions and the desktop format and refresh rate
  *  are used.
  *  
+ *  \param window The window for which the display mode should be set.
  *  \param mode The mode to use, or NULL for the default mode.
  *  
  *  \return 0 on success, or -1 if setting the display mode failed.
@@ -450,6 +452,7 @@
 /**
  *  \brief Set the icon for a window.
  *  
+ *  \param window The window for which the icon should be set.
  *  \param icon The icon for the window.
  */
 extern DECLSPEC void SDLCALL SDL_SetWindowIcon(SDL_Window * window,
@@ -707,6 +710,7 @@
 /**
  *  \brief Set a window's input grab mode.
  *  
+ *  \param window The window for which the input grab mode should be set.
  *  \param grabbed This is SDL_TRUE to grab input, and SDL_FALSE to release input.
  *  
  *  \sa SDL_GetWindowGrab()
@@ -745,6 +749,7 @@
 /**
  *  \brief Set the gamma ramp for a window.
  *  
+ *  \param window The window for which the gamma ramp should be set.
  *  \param red The translation table for the red channel, or NULL.
  *  \param green The translation table for the green channel, or NULL.
  *  \param blue The translation table for the blue channel, or NULL.
@@ -767,6 +772,7 @@
 /**
  *  \brief Get the gamma ramp for a window.
  *  
+ *  \param window The window from which the gamma ramp should be queried.
  *  \param red   A pointer to a 256 element array of 16-bit quantities to hold 
  *               the translation table for the red channel, or NULL.
  *  \param green A pointer to a 256 element array of 16-bit quantities to hold