gosu 1.3.0 → 1.4.3

data/include/Gosu/Directories.hpp

@@ -1,36 +1,43 @@
-//! \file Directories.hpp
-//! Access to a small set of system paths.
-
 #pragma once
 
 #include <string>
 
 namespace Gosu
 {
-    //! Changes the current directory to the result of resource_prefix().
+    /// Changes the current directory to the result of resource_prefix().
     void use_resource_directory();
     
-    //! Prefix for a program's own resources.
-    //! On Windows, the parent directory of the executable.
-    //! On macOS, the 'Resources' directory inside the .app bundle.
-    //! On Linux, the current directory (empty string).
-    std::string resource_prefix();
+    /// Prefix for a program's own resources.
+    /// <ul>
+    /// <li> Windows: The parent directory of the executable.
+    /// <li> macOS, iOS: The 'Resources' directory inside the .app bundle.
+    /// <li> Linux: The current directory (empty string).
+    /// </ul>
+    const std::string& resource_prefix();
     
-    //! Prefix for shared resources of a group of programs.
-    //! On Windows, the parent directory of the executable.
-    //! On macOS, the parent directory of the .app bundle.
-    //! On Linux, the current directory (empty string).
-    std::string shared_resource_prefix();
+    /// Prefix for shared resources of a group of programs, e.g. the game and its level editor.
+    /// <ul>
+    /// <li> Windows: The parent directory of the executable.
+    /// <li> macOS: The parent directory of the .app bundle.
+    /// <li> Linux: The current directory (empty string).
+    /// </uil>
+    const std::string& shared_resource_prefix();
     
-    //! Prefix for user settings.
-    //! On Windows, the same as %APPDATA%.
-    //! On macOS, the user's Library/Preferences folder.
-    //! On Linux, the home directory plus a trailing dot for hidden files.
-    std::string user_settings_prefix();
+    /// Prefix for user settings.
+    /// <ul>
+    /// <li> Windows: The same as %APPDATA%.
+    /// <li> macOS: The user's Library/Preferences folder.
+    /// <li> Linux: The home directory plus a trailing dot for hidden files.
+    /// </ul>
+    const std::string& user_settings_prefix();
     
-    //! Prefix for user documents, e.g. saved games.
-    //! On Windows, the My Documents folder.
-    //! On macOS, the user's Documents folder.
-    //! On Linux, the home directory.
-    std::string user_documents_prefix();
+    /// Prefix for user documents, e.g. saved games.
+    /// <ul>
+    /// <li> Windows: The "My Documents" folder.
+    /// <li> macOS: The user's "Documents" folder.
+    /// <li> Linux: The home directory.
+    /// </ul>
+    const std::string& user_documents_prefix();
+
+    // TODO: Instead of re-inventing wheels here, we should wrap SDL_GetBasePath / SDL_GetPrefPath.
 }

data/include/Gosu/Font.hpp

@@ -1,6 +1,3 @@
-//! \file Font.hpp
-//! Interface of the Font class.
-
 #pragma once
 
 #include <Gosu/Fwd.hpp>
@@ -13,66 +10,67 @@
 
 namespace Gosu
 {
-    //! Fonts are ideal for drawing short, dynamic strings.
-    //! For large, static texts you should use Gosu::layout_text and turn the result into an image.
+    /// A simple bitmap font that renders and caches glyphs on demand.
+    /// For large, static texts you should use Gosu::layout_text and turn the result into an image.
     class Font
     {
         struct Impl;
-        std::shared_ptr<Impl> pimpl;
+        std::shared_ptr<Impl> m_impl;
 
     public:
-        //! Constructs a font that can be drawn onto the graphics object.
-        //! \param name   Name of a system font, or a filename to a TTF file.
-        //! \param height Height of the font, in pixels.
-        //! \param flags  Flags used to render individual characters of the font.
-        Font(int height, const std::string& name = default_font_name(), unsigned flags = 0);
-        
-        //! Returns the name of the font that was used to create it.
+        /// @param name   Name of a system font, or path to a TTF file (must contain '/').
+        /// @param height Height of the font, in pixels.
+        /// @param font_flags  Flags used to render individual characters of the font (FontFlags enum).
+        /// @param image_flags  Flags used to render individual characters of the font (ImageFlags enum).
+        explicit Font(int height, const std::string& name = default_font_name(),
+                      unsigned font_flags = 0, unsigned image_flags = 0);
+
+        /// Returns the name of the font that was used to create it, i.e. the filename, nor the
+        /// internal TTF name. (TODO: Why not?)
         const std::string& name() const;
-        
-        //! Returns the height of the font, in pixels.
+
+        /// Returns the height of the font, in pixels.
         int height() const;
-        
-        //! Returns the flags used to create the font characters.
+
+        /// Returns the flags used to render the characters of the font (FontFlags enum).
         unsigned flags() const;
-        
-        //! Returns the width, in pixels, the given text would occupy if drawn.
+        unsigned image_flags() const;
+
+        /// Returns the width, in pixels, that the given text would occupy if drawn.
         double text_width(const std::string& text) const;
-        //! Returns the width, in pixels, the given markup would occupy if drawn.
+        /// Returns the width, in pixels, that the given markup would occupy if drawn.
         double markup_width(const std::string& markup) const;
-        
-        //! Draws text so the top left corner of the text is at (x; y).
-        void draw_text(const std::string& text, double x, double y, ZPos z,
+
+        /// Draws text so the top left corner of the text is at (x; y).
+        void draw_text(const std::string& text, double x, double y, ZPos z, //
                        double scale_x = 1, double scale_y = 1, Color c = Color::WHITE,
                        BlendMode mode = BM_DEFAULT) const;
-        //! Draws markup so the top left corner of the text is at (x; y).
-        void draw_markup(const std::string& markup, double x, double y, ZPos z,
+        /// Draws markup so the top left corner of the text is at (x; y).
+        void draw_markup(const std::string& markup, double x, double y, ZPos z, //
                          double scale_x = 1, double scale_y = 1, Color c = Color::WHITE,
                          BlendMode mode = BM_DEFAULT) const;
-        
-        //! Draws text at a position relative to (x; y).
-        //! \param rel_x Determines where the text is drawn horizontally. If
-        //! rel_x is 0.0, the text will be to the right of x, if it is 1.0,
-        //! the text will be to the left of x, if it is 0.5, it will be
-        //! centered on x. All real numbers are possible values.
-        //! \param rel_y See rel_x.
-        void draw_text_rel(const std::string& text, double x, double y, ZPos z,
+
+        /// Draws text at a position relative to (x; y).
+        /// @param rel_x Determines where the text is drawn horizontally. If rel_x is 0.0, the text
+        /// will be to the right of x, if it is 1.0, the text will be to the left of x, if it is
+        /// 0.5, it will be centered on x.
+        /// @param rel_y See rel_x.
+        void draw_text_rel(const std::string& text, double x, double y, ZPos z, //
                            double rel_x, double rel_y, double scale_x = 1, double scale_y = 1,
                            Color c = Color::WHITE, BlendMode mode = BM_DEFAULT) const;
-        //! Draws text at a position relative to (x; y).
-        //! \param rel_x Determines where the text is drawn horizontally. If
-        //! rel_x is 0.0, the text will be to the right of x, if it is 1.0,
-        //! the text will be to the left of x, if it is 0.5, it will be
-        //! centered on x. All real numbers are possible values.
-        //! \param rel_y See rel_x.
-        void draw_markup_rel(const std::string& markup, double x, double y, ZPos z,
+        /// Draws markup at a position relative to (x; y).
+        /// @param rel_x Determines where the text is drawn horizontally. If rel_x is 0.0, the text
+        /// will be to the right of x, if it is 1.0, the text will be to the left of x, if it is
+        /// 0.5, it will be centered on x.
+        /// @param rel_y See rel_x.
+        void draw_markup_rel(const std::string& markup, double x, double y, ZPos z, //
                              double rel_x, double rel_y, double scale_x = 1, double scale_y = 1,
                              Color c = Color::WHITE, BlendMode mode = BM_DEFAULT) const;
-        
-        //! Maps a letter to a specific image, instead of generating one using
-        //! Gosu's built-in text rendering.
+
+        /// Maps a letter to a specific image, instead of generating one using Gosu's built-in text
+        /// rendering.
         void set_image(std::string codepoint, unsigned font_flags, const Gosu::Image& image);
-        //! A shortcut for mapping a character to an image regardless of font_flags.
+        /// A shortcut for mapping a character to an image regardless of font_flags.
         void set_image(std::string codepoint, const Gosu::Image& image);
     };
 }

data/include/Gosu/Gosu.hpp

@@ -1,11 +1,8 @@
-//! \file Gosu.hpp
-//! Umbrella header for all of Gosu.
-
-//! \mainpage Gosu C++ Documentation
-//!
-//! These pages serve as a reference on the C++ interface of Gosu. For a higher-level
-//! discussion of concepts and ideas behind the library, see the Wiki entries linked
-//! from the official website, https://www.libgosu.org/.
+/// \mainpage Gosu C++ Documentation
+///
+/// These pages serve as a reference on the C++ interface of Gosu. For a higher-level
+/// discussion of concepts and ideas behind the library, see the Wiki entries linked
+/// from the official website, https://www.libgosu.org/.
 
 #pragma once
 

data/include/Gosu/Graphics.hpp

@@ -1,6 +1,3 @@
-//! \file Graphics.hpp
-//! Interface of the Graphics class.
-
 #pragma once
 
 #include <Gosu/Fwd.hpp>
@@ -12,19 +9,17 @@
 namespace Gosu
 {
     struct DrawOp;
-    
-    //! Returns the maximum size of an texture that will be allocated
-    //! internally by Gosu.
-    //! Useful when extending Gosu using OpenGL.
+
+    /// Returns the maximum size of an texture that will be allocated internally by Gosu.
+    /// Useful when extending Gosu using OpenGL.
     const unsigned MAX_TEXTURE_SIZE = 1024;
-    
-    //! Serves as the target of all drawing and provides primitive drawing
-    //! functionality.
-    //! Usually created internally by Gosu::Window.
+
+    /// Serves as the target of all drawing and provides primitive drawing functionality.
+    /// Usually created internally by Gosu::Window.
     class Graphics
     {
         struct Impl;
-        std::unique_ptr<Impl> pimpl;
+        std::unique_ptr<Impl> m_impl;
 
     public:
         Graphics(unsigned physical_width, unsigned physical_height);
@@ -32,80 +27,72 @@ namespace Gosu
 
         void set_resolution(unsigned logical_width, unsigned logical_height,
                             double black_bar_width = 0, double black_bar_height = 0);
-        
+
         unsigned width() const;
         unsigned height() const;
 
-        //! Prepares the graphics object for drawing and then runs the rendering code in f.
-        //! Nothing must be drawn outside of frame() and record().
-        void frame(const std::function<void ()>& f);
-        
-        //! Flushes the Z queue to the screen and starts a new one.
-        //! This can be useful to separate the Z queues of two parts of the game, e.g. the two
-        //! halves of a game that runs in split-screen mode.
+        /// Prepares the graphics object for drawing and then runs the rendering code in f.
+        /// Nothing must be drawn outside of frame() and record().
+        void frame(const std::function<void()>& f);
+
+        /// Flushes the Z queue to the screen and starts a new one.
+        /// This can be useful to separate the Z queues of two parts of the game, e.g. the two
+        /// halves of a game that runs in split-screen mode.
         static void flush();
-        
-        //! Finishes all pending Gosu drawing operations and executes the code in f in a clean
-        //! OpenGL environment.
-        static void gl(const std::function<void ()>& f);
-
-        //! Schedules a custom GL functor to be executed at a certain Z level.
-        //! The functor f is run in a clean GL context.
-        //! Note: You may not call any Gosu rendering functions from within the
-        //! functor.
-        static void gl(ZPos z, const std::function<void ()>& f);
-        
-        //! Renders everything drawn in f clipped to a rectangle on the screen.
+
+        /// Finishes all pending Gosu drawing operations and executes the code in f in a clean
+        /// OpenGL environment.
+        static void gl(const std::function<void()>& f);
+
+        /// Schedules a custom GL functor to be executed at a certain Z level.
+        /// The functor f is run in a clean GL context.
+        /// Note: You may not call any Gosu rendering functions from within the functor.
+        static void gl(ZPos z, const std::function<void()>& f);
+
+        /// Renders everything drawn in f clipped to a rectangle on the screen.
         static void clip_to(double x, double y, double width, double height,
-                            const std::function<void ()>& f);
-        
-        //! Renders everything drawn in f onto a new Image of size (width, height).
-        //! \param image_flags Pass Gosu::IF_RETRO if you do not want the resulting image to use
-        //! interpolation when it is scaled or rotated.
-        static Gosu::Image render(int width, int height, const std::function<void ()>& f,
+                            const std::function<void()>& f);
+
+        /// Renders everything drawn in f onto a new Image of size (width, height).
+        /// @param image_flags Pass Gosu::IF_RETRO if you do not want the resulting image to use
+        /// interpolation when it is scaled or rotated.
+        static Gosu::Image render(int width, int height, const std::function<void()>& f,
                                   unsigned image_flags = 0);
-        
-        //! Records a macro and returns it as an Image.
-        static Gosu::Image record(int width, int height, const std::function<void ()>& f);
-        
-        //! Pushes one transformation onto the transformation stack.
-        static void transform(const Transform& transform,
-                              const std::function<void ()>& f);
-
-        //! Draws a line from one point to another (last pixel exclusive).
-        //! Note: OpenGL lines are not reliable at all and may have a missing pixel at the start
-        //! or end point. Please only use this for debugging purposes. Otherwise, use a quad or
-        //! image to simulate lines, or contribute a better draw_line to Gosu.
-        static void draw_line(double x1, double y1, Color c1,
-                              double x2, double y2, Color c2,
+
+        /// Records a macro and returns it as an Image.
+        static Gosu::Image record(int width, int height, const std::function<void()>& f);
+
+        /// Pushes one transformation onto the transformation stack.
+        static void transform(const Transform& transform, const std::function<void()>& f);
+
+        /// Draws a line from one point to another (last pixel exclusive).
+        /// Note: OpenGL lines are not reliable at all and may have a missing pixel at the start
+        /// or end point. Please only use this for debugging purposes. Otherwise, use a quad or
+        /// image to simulate lines, or contribute a better draw_line to Gosu.
+        static void draw_line(double x1, double y1, Color c1, double x2, double y2, Color c2,
                               ZPos z, BlendMode mode = BM_DEFAULT);
 
-        static void draw_triangle(double x1, double y1, Color c1,
-                                  double x2, double y2, Color c2,
-                                  double x3, double y3, Color c3,
-                                  ZPos z,
-                                  BlendMode mode = BM_DEFAULT);
+        static void draw_triangle(double x1, double y1, Color c1, //
+                                  double x2, double y2, Color c2, //
+                                  double x3, double y3, Color c3, //
+                                  ZPos z, BlendMode mode = BM_DEFAULT);
 
-        static void draw_quad(double x1, double y1, Color c1,
-                              double x2, double y2, Color c2,
-                              double x3, double y3, Color c3,
-                              double x4, double y4, Color c4,
+        static void draw_quad(double x1, double y1, Color c1, double x2, double y2, Color c2,
+                              double x3, double y3, Color c3, double x4, double y4, Color c4,
                               ZPos z, BlendMode mode = BM_DEFAULT);
-        
-        static void draw_rect(double x, double y, double width, double height,
-                              Color c, ZPos z,
+
+        static void draw_rect(double x, double y, double width, double height, Color c, ZPos z,
                               BlendMode mode = BM_DEFAULT);
 
-        //! For internal use only.
+        /// For internal use only.
         void set_physical_resolution(unsigned physical_width, unsigned physical_height);
 
-        //! For internal use only.
+        /// For internal use only.
         static void schedule_draw_op(const DrawOp& op);
 
-        //! Turns a portion of a bitmap into something that can be drawn on a Graphics object.
-        static std::unique_ptr<ImageData> create_image(const Bitmap& src,
-                                                       unsigned src_x,     unsigned src_y,
-                                                       unsigned src_width, unsigned src_height,
-                                                       unsigned image_flags);
+        /// Turns a portion of a bitmap into something that can be drawn on a Graphics object.
+        static std::unique_ptr<ImageData> create_image(const Bitmap& src, unsigned src_x,
+                                                       unsigned src_y, unsigned src_width,
+                                                       unsigned src_height, unsigned image_flags);
     };
 }

data/include/Gosu/GraphicsBase.hpp

@@ -1,6 +1,3 @@
-//! \file GraphicsBase.hpp
-//! Contains general typedefs and enums related to graphics.
-
 #pragma once
 
 #include <Gosu/Platform.hpp>
@@ -8,35 +5,32 @@
 
 namespace Gosu
 {
-    //! Represents the Z position of something drawn with Gosu's graphics
-    //! system. Draw calls with higher ZPos values will cover those with a
-    //! lower ZPos value.
+    /// Represents the Z position of something drawn with Gosu's graphics system.
+    /// Draw calls with higher ZPos values will cover those with a lower ZPos value.
     typedef double ZPos;
-    
-    //! Determines the way colors are combined when one is drawn onto
-    //! another.
+
+    /// Determines the way pixel colors are combined when images overlap.
     enum BlendMode
     {
         BM_DEFAULT,
-        //! The color's channels will be interpolated. The alpha channel
-        //! specifies the opacity of the new color, 255 is full opacity.
+        /// The color's channels will be interpolated. The alpha channel specifies the opacity of
+        /// the new color, 255 is full opacity.
         BM_INTERPOLATE = BM_DEFAULT,
-        //! The colors' channels will be added. The alpha channel specifies
-        //! the percentage of the new color's channels that will be added
-        //! to the old color's channels.
+        /// The colors' channels will be added. The alpha channel specifies the percentage of the
+        /// new color's channels that will be added to the old color's channels.
         BM_ADD,
-        //! The color's channels will be multiplied with each other.
+        /// The color's channels will be multiplied with each other.
         BM_MULTIPLY
     };
-    
+
     enum FontFlags
     {
-        FF_BOLD         = 1,
-        FF_ITALIC       = 2,
-        FF_UNDERLINE    = 4,
+        FF_BOLD = 1,
+        FF_ITALIC = 2,
+        FF_UNDERLINE = 4,
         FF_COMBINATIONS = 8
     };
-    
+
     enum Alignment
     {
         AL_LEFT,
@@ -44,26 +38,25 @@ namespace Gosu
         AL_CENTER,
         AL_JUSTIFY
     };
-    
-    //! Flags that affect the tileability or interpolation of an image.
+
+    /// Flags that affect the tileability or interpolation of an image.
     enum ImageFlags
     {
         IF_SMOOTH = 0,
-        
+
         // Note: No constant for '1', but Gosu treats '1' as IF_TILEABLE for
         // backward compatibility reasons (this parameter used to be a bool).
-        
-        IF_TILEABLE_LEFT   = 1 << 1,
-        IF_TILEABLE_TOP    = 1 << 2,
-        IF_TILEABLE_RIGHT  = 1 << 3,
+
+        IF_TILEABLE_LEFT = 1 << 1,
+        IF_TILEABLE_TOP = 1 << 2,
+        IF_TILEABLE_RIGHT = 1 << 3,
         IF_TILEABLE_BOTTOM = 1 << 4,
-        IF_TILEABLE        = IF_TILEABLE_LEFT | IF_TILEABLE_TOP | IF_TILEABLE_RIGHT | IF_TILEABLE_BOTTOM,
-        
-        //! Apply nearest-neighbor interpolation when scaling this image up or
-        //! down.
-        IF_RETRO           = 1 << 5
+        IF_TILEABLE = IF_TILEABLE_LEFT | IF_TILEABLE_TOP | IF_TILEABLE_RIGHT | IF_TILEABLE_BOTTOM,
+
+        /// Apply nearest-neighbor interpolation when scaling this image up or down.
+        IF_RETRO = 1 << 5
     };
-    
+
     typedef std::array<double, 16> Transform;
     Transform translate(double x, double y);
     Transform rotate(double angle, double around_x = 0, double around_y = 0);

data/include/Gosu/IO.hpp

@@ -1,6 +1,3 @@
-//! \file IO.hpp
-//! Contains everything related to input and output.
-
 #pragma once
 
 #include <Gosu/Platform.hpp>

data/include/Gosu/Image.hpp

@@ -1,6 +1,3 @@
-//! \file Image.hpp
-//! Interface of the Image class and helper functions.
-
 #pragma once
 
 #include <Gosu/Fwd.hpp>
@@ -12,80 +9,77 @@
 
 namespace Gosu
 {
-    //! Provides functionality for drawing rectangular images.
+    /// Provides functionality for drawing rectangular images.
     class Image
     {
-        std::shared_ptr<ImageData> data_;
+        std::shared_ptr<ImageData> m_data;
 
     public:
-        //! Creates an empty image. It will have a width and height of 0, and not contain anything.
+        /// Creates an empty image. It will have a width and height of 0, and not contain anything.
         Image();
-        
-        //! Loads an image from a given filename.
-        //!
-        //! A color key of #ff00ff is automatically applied to BMP image files.
-        //! For more flexibility, use the corresponding constructor that uses a Bitmap object.
+
+        /// Loads an image from a given filename.
+        ///
+        /// A color key of #ff00ff is automatically applied to BMP image files.
+        /// For more flexibility, use the corresponding constructor that uses a Bitmap object.
         explicit Image(const std::string& filename, unsigned image_flags = IF_SMOOTH);
-        
+
         //! Loads a portion of the the image at the given filename..
-        //!
-        //! A color key of #ff00ff is automatically applied to BMP image files.
-        //! For more flexibility, use the corresponding constructor that uses a Bitmap object.
-        Image(const std::string& filename, int src_x, int src_y,
-            int src_width, int src_height, unsigned image_flags = IF_SMOOTH);
-        
-        //! Converts the given bitmap into an image.
+        ///
+        /// A color key of #ff00ff is automatically applied to BMP image files.
+        /// For more flexibility, use the corresponding constructor that uses a Bitmap object.
+        Image(const std::string& filename, int src_x, int src_y, int src_width, int src_height,
+              unsigned image_flags = IF_SMOOTH);
+
+        /// Converts the given bitmap into an image.
         explicit Image(const Bitmap& source, unsigned image_flags = IF_SMOOTH);
-        
-        //! Converts a portion of the given bitmap into an image.
-        Image(const Bitmap& source, int src_x, int src_y, int src_width,
-              int src_height, unsigned image_flags = IF_SMOOTH);
-        
-        //! Creates an Image from a user-supplied instance of the ImageData interface.
+
+        /// Converts a portion of the given bitmap into an image.
+        Image(const Bitmap& source, int src_x, int src_y, int src_width, int src_height,
+              unsigned image_flags = IF_SMOOTH);
+
+        /// Creates an Image from a user-supplied instance of the ImageData interface.
         explicit Image(std::unique_ptr<ImageData>&& data);
 
         unsigned width() const;
         unsigned height() const;
 
-        //! Draws the image so its upper left corner is at (x; y).
+        /// Draws the image so its upper left corner is at (x; y).
         void draw(double x, double y, ZPos z = 0, double scale_x = 1, double scale_y = 1,
-            Color c = Color::WHITE, BlendMode mode = BM_DEFAULT) const;
-        //! Like draw(), but with modulation colors for all four corners.
-        void draw_mod(double x, double y, ZPos z, double scale_x, double scale_y,
-            Color c1, Color c2, Color c3, Color c4, BlendMode mode = BM_DEFAULT) const;
+                  Color c = Color::WHITE, BlendMode mode = BM_DEFAULT) const;
+        /// Like draw(), but with modulation colors for all four corners.
+        void draw_mod(double x, double y, ZPos z, double scale_x, double scale_y, Color c1,
+                      Color c2, Color c3, Color c4, BlendMode mode = BM_DEFAULT) const;
+
+        /// Draws the image rotated by the given angle so that its rotation center is at (x; y).
+        /// Note that this is different from how all the other drawing functions work!
+        /// @param angle See Math.hpp for an explanation of how Gosu interprets angles.
+        /// @param center_x Relative horizontal position of the rotation center on the image.
+        /// 0 is the left border, 1 is the right border, 0.5 is the center (and default).
+        /// @param center_y See center_x.
+        void draw_rot(double x, double y, ZPos z = 0, double angle = 0, double center_x = 0.5,
+                      double center_y = 0.5, double scale_x = 1, double scale_y = 1,
+                      Color c = Color::WHITE, BlendMode mode = BM_DEFAULT) const;
 
-        //! Draws the image rotated by the given angle so that its rotation
-        //! center is at (x; y). Note that this is different from how all the
-        //! other drawing functions work!
-        //! \param angle See Math.hpp for an explanation of how Gosu interprets
-        //! angles.
-        //! \param center_x Relative horizontal position of the rotation center
-        //! on the image. 0 is the left border, 1 is the right border, 0.5 is
-        //! the center (and default).
-        //! \param center_y See center_x.
-        void draw_rot(double x, double y, ZPos z = 0, double angle = 0,
-            double center_x = 0.5, double center_y = 0.5, double scale_x = 1, double scale_y = 1,
-            Color c = Color::WHITE, BlendMode mode = BM_DEFAULT) const;
-        
-        #ifndef SWIG
-        //! Provides access to the underlying image data object.
+#ifndef SWIG
+        /// Provides access to the underlying image data object.
         ImageData& data() const;
-        #endif
+#endif
     };
-    
-    #ifndef SWIG
-    //! Convenience function that slices an image file into a grid and creates images from them.
-    //! \param tile_width If positive, specifies the width of one tile in pixels.
-    //! If negative, the bitmap is divided into -tile_width rows.
-    //! \param tile_height See tile_width.
-    std::vector<Gosu::Image> load_tiles(const Bitmap& bmp,
-        int tile_width, int tile_height, unsigned image_flags = IF_SMOOTH);
-    
-    //! Convenience function that slices a bitmap into a grid and creates images from them.
-    //! \param tile_width If positive, specifies the width of one tile in pixels.
-    //! If negative, the bitmap is divided into -tile_width rows.
-    //! \param tile_height See tile_width.
-    std::vector<Gosu::Image> load_tiles(const std::string& filename,
-        int tile_width, int tile_height, unsigned image_flags = IF_SMOOTH);
-    #endif
+
+#ifndef SWIG
+    /// Convenience function that slices an image file into a grid and creates images from them.
+    /// @param tile_width If positive, specifies the width of one tile in pixels.
+    /// If negative, the bitmap is divided into -tile_width rows.
+    /// @param tile_height See tile_width.
+    std::vector<Gosu::Image> load_tiles(const Bitmap& bmp, int tile_width, int tile_height,
+                                        unsigned image_flags = IF_SMOOTH);
+
+    /// Convenience function that slices a bitmap into a grid and creates images from them.
+    /// @param tile_width If positive, specifies the width of one tile in pixels.
+    /// If negative, the bitmap is divided into -tile_width rows.
+    /// @param tile_height See tile_width.
+    std::vector<Gosu::Image> load_tiles(const std::string& filename, int tile_width,
+                                        int tile_height, unsigned image_flags = IF_SMOOTH);
+#endif
 }