diff include/SDL_shape.h @ 4779:bb179250fcb3

Doxygen commenting is all finished up.
author Eli Gottlieb <eligottlieb@gmail.com>
date Thu, 10 Jun 2010 17:50:38 -0400
parents 9838d3525a1b
children 4f915a47b995
line wrap: on
line diff
--- a/include/SDL_shape.h	Thu Jun 10 17:37:19 2010 -0400
+++ b/include/SDL_shape.h	Thu Jun 10 17:50:38 2010 -0400
@@ -37,6 +37,11 @@
 /* *INDENT-ON* */
 #endif
 
+/** \file SDL_shape.h
+ *
+ * Header file for shaped windows.
+ */
+
 /**
  *  \brief Create a shaped window with the specified position, dimensions, and flags.
  *  
@@ -99,7 +104,9 @@
 
 /** \brief A struct that tags the SDL_WindowShapeParams union with an enum describing the type of its contents. */
 typedef struct SDL_WindowShapeMode {
+	/** \brief The mode of these window-shape parameters. */
 	WindowShapeMode mode;
+	/** \brief Window-shape parameters. */
 	SDL_WindowShapeParams parameters;
 } SDL_WindowShapeMode;