From a35cbeab46664e7c6fc1be22f45b74afaa9851e5 Mon Sep 17 00:00:00 2001 From: Bartosz Gentkowski Date: Sun, 29 Nov 2020 02:55:02 +0100 Subject: [PATCH] DOXYGEN: Add doxy groups to remaining headers in 'graphics' To make sure that they appear in the graphics group in the doc structure. --- graphics/VectorRenderer.h | 10 +++++++++- graphics/VectorRendererSpec.h | 11 ++++++++++- graphics/conversion.h | 11 ++++++++++- graphics/cursor.h | 11 ++++++++++- graphics/fontman.h | 17 +++++++++++++++-- graphics/korfont.h | 11 ++++++++++- graphics/maccursor.h | 12 +++++++++--- graphics/palette.h | 11 ++++++++++- graphics/pixelbuffer.h | 11 ++++++++++- graphics/renderer.h | 11 ++++++++++- graphics/screen.h | 11 ++++++++++- graphics/sjis.h | 11 ++++++++++- graphics/thumbnail.h | 11 ++++++++++- graphics/transparent_surface.h | 11 ++++++++++- graphics/wincursor.h | 11 ++++++++++- graphics/yuv_to_rgb.h | 9 ++++++--- 16 files changed, 159 insertions(+), 21 deletions(-) diff --git a/graphics/VectorRenderer.h b/graphics/VectorRenderer.h index 240e601acbc..d1a8654e861 100644 --- a/graphics/VectorRenderer.h +++ b/graphics/VectorRenderer.h @@ -38,6 +38,14 @@ namespace Graphics { class VectorRenderer; struct DrawStep; +/** + * @defgroup graphics_vector_renderer Vector renderer + * @ingroup graphics + * + * @brief VectorRenderer for drawing on a given surface. + * + * @{ + */ typedef void (VectorRenderer::*DrawingFunctionCallback)(const Common::Rect &, const Graphics::DrawStep &); @@ -557,7 +565,7 @@ protected: int _gradientFactor; /**< Multiplication factor of the active gradient */ }; - +/** @} */ } // End of namespace Graphics #endif diff --git a/graphics/VectorRendererSpec.h b/graphics/VectorRendererSpec.h index eef17b7d491..c1c49133885 100644 --- a/graphics/VectorRendererSpec.h +++ b/graphics/VectorRendererSpec.h @@ -27,6 +27,15 @@ namespace Graphics { +/** + * @defgroup graphics_vector_renderer_spec Specialized vector renderer + * @ingroup graphics + * + * @brief VectorRendererSpec class. + * + * @{ + */ + /** * VectorRendererSpec: Specialized Vector Renderer Class * @@ -379,6 +388,6 @@ protected: int baseLeft = 0, int baseRight = 0); }; #endif - +/** @} */ } #endif diff --git a/graphics/conversion.h b/graphics/conversion.h index b0b376babdb..597fb22988f 100644 --- a/graphics/conversion.h +++ b/graphics/conversion.h @@ -27,6 +27,15 @@ namespace Graphics { +/** + * @defgroup graphics_conversion Conversions + * @ingroup graphics + * + * @brief Graphics conversion operations. + * + * @{ + */ + struct PixelFormat; /** Converting a color from YUV to RGB colorspace. */ @@ -99,7 +108,7 @@ bool scaleBlitBilinear(byte *dst, const byte *src, const uint dstW, const uint dstH, const uint srcW, const uint srcH, const Graphics::PixelFormat &fmt); - +/** @} */ } // End of namespace Graphics #endif // GRAPHICS_CONVERSION_H diff --git a/graphics/cursor.h b/graphics/cursor.h index 354d981de64..ab1bba8e8e5 100644 --- a/graphics/cursor.h +++ b/graphics/cursor.h @@ -27,6 +27,15 @@ namespace Graphics { +/** + * @defgroup graphics_cursor Cursor + * @ingroup graphics + * + * @brief Cursor class used for representing the mouse cursor on the screen. + * + * @{ + */ + /** * A simple cursor representation * TODO: Switch to using Graphics::Surface instead of a byte* @@ -57,7 +66,7 @@ public: /** Return the number of colors in the palette. */ virtual uint16 getPaletteCount() const = 0; }; - +/** @} */ } // End of namespace Graphics #endif diff --git a/graphics/fontman.h b/graphics/fontman.h index 515b157e6aa..08afc07c2f5 100644 --- a/graphics/fontman.h +++ b/graphics/fontman.h @@ -32,6 +32,15 @@ namespace Graphics { +/** + * @defgroup graphics_fontman Font manager + * @ingroup graphics + * + * @brief FontManager class used for managing fonts. + * + * @{ + */ + class Font; class BdfFont; @@ -117,10 +126,14 @@ private: Common::String _localizedFontName; }; - +/** @} */ } // End of namespace Graphics +/** @addtogroup graphics_fontman + * @{ + */ + /** Shortcut for accessing the font manager. */ #define FontMan (Graphics::FontManager::instance()) - + /** @} */ #endif diff --git a/graphics/korfont.h b/graphics/korfont.h index fc815df064c..13b13fcc32e 100644 --- a/graphics/korfont.h +++ b/graphics/korfont.h @@ -28,6 +28,15 @@ namespace Graphics { +/** + * @defgroup graphics_fontman Korean font + * @ingroup graphics + * + * @brief FontKorean class used to handle Korean characters. + * + * @{ + */ + /** * A font that is able to draw Korean encoded characters. */ @@ -219,7 +228,7 @@ private: bool englishLoadData(const char *fontFile); }; - + /** @} */ } // End of namespace Graphics #endif diff --git a/graphics/maccursor.h b/graphics/maccursor.h index 64a2e959229..798cb77dc61 100644 --- a/graphics/maccursor.h +++ b/graphics/maccursor.h @@ -21,11 +21,17 @@ */ /** - * @file - * Macintosh cursor decoding used in engines: + * @defgroup graphics_maccursor Mac cursor + * @ingroup graphics + * + * @brief Macintosh cursor decoding. + * + * Used in engines: * - mohawk * - sci * - scumm + * + * @{ */ #ifndef GRAPHICS_MACCURSOR_H @@ -78,7 +84,7 @@ protected: /** Clear the cursor. */ void clear(); }; - + /** @} */ } // End of namespace Graphics #endif diff --git a/graphics/palette.h b/graphics/palette.h index 0b9b861aa97..8f67036208d 100644 --- a/graphics/palette.h +++ b/graphics/palette.h @@ -26,6 +26,15 @@ #include "common/scummsys.h" #include "common/noncopyable.h" +/** + * @defgroup graphics_palette PaletteManager + * @ingroup graphics + * + * @brief The PaletteManager class. + * + * @{ + */ + /** * The PaletteManager is part of the OSystem backend API and responsible * for handling the (possibly emulated) "hardware" palette needed for @@ -98,5 +107,5 @@ public: */ virtual void grabPalette(byte *colors, uint start, uint num) const = 0; }; - + /** @} */ #endif diff --git a/graphics/pixelbuffer.h b/graphics/pixelbuffer.h index fd3def9cc16..6515fd02f5e 100644 --- a/graphics/pixelbuffer.h +++ b/graphics/pixelbuffer.h @@ -32,6 +32,15 @@ namespace Graphics { +/** + * @defgroup graphics_pixelbuffer Pixel buffers + * @ingroup graphics + * + * @brief Class for managing pixel buffers. + * + * @{ + */ + class PixelBuffer { public: /** @@ -269,5 +278,5 @@ private: }; } - + /** @} */ #endif diff --git a/graphics/renderer.h b/graphics/renderer.h index 85934ca5381..55c368992b6 100644 --- a/graphics/renderer.h +++ b/graphics/renderer.h @@ -28,6 +28,15 @@ namespace Graphics { +/** + * @defgroup graphics_renderer Renderer + * @ingroup graphics + * + * @brief API for managing renderer engines. + * + * @{ + */ + /** * List of renderer types * @@ -56,7 +65,7 @@ Common::String getRendererTypeCode(RendererType type); /** Get the best matching renderer among available renderers */ RendererType getBestMatchingAvailableRendererType(RendererType desired); - + /** @} */ } // End of namespace Graphics #endif diff --git a/graphics/screen.h b/graphics/screen.h index 995c5456ff1..ef5dfac7a7b 100644 --- a/graphics/screen.h +++ b/graphics/screen.h @@ -30,6 +30,15 @@ namespace Graphics { +/** + * @defgroup graphics_screen Screen + * @ingroup graphics + * + * @brief Screen class for managing the screen. + * + * @{ + */ + #define PALETTE_COUNT 256 #define PALETTE_SIZE (256 * 3) @@ -117,7 +126,7 @@ public: */ void clearPalette(); }; - + /** @} */ } // End of namespace Graphics #endif diff --git a/graphics/sjis.h b/graphics/sjis.h index 19500ec0437..5322c6db980 100644 --- a/graphics/sjis.h +++ b/graphics/sjis.h @@ -48,6 +48,15 @@ namespace Graphics { +/** + * @defgroup graphics_sjis Shift JIS font + * @ingroup graphics + * + * @brief FontSJIS class for handling Japanese characters. + * + * @{ + */ + struct Surface; /** @@ -285,7 +294,7 @@ private: }; // TODO: Consider adding support for PC98 ROM - + /** @} */ } // End of namespace Graphics #endif diff --git a/graphics/thumbnail.h b/graphics/thumbnail.h index 17ce856e23b..72ae11a95fd 100644 --- a/graphics/thumbnail.h +++ b/graphics/thumbnail.h @@ -32,6 +32,15 @@ class WriteStream; namespace Graphics { +/** + * @defgroup graphics_thumbnail Thumbnails + * @ingroup graphics + * + * @brief API for managing screen thumbnails used for save games. + * + * @{ + */ + struct Surface; /** @@ -82,7 +91,7 @@ bool createScreenShot(Graphics::Surface &surf); */ Graphics::Surface *scale(const Graphics::Surface &srcImage, int xSize, int ySize); - +/** @} */ } // End of namespace Graphics #endif diff --git a/graphics/transparent_surface.h b/graphics/transparent_surface.h index 3741344708d..6164b17f4ea 100644 --- a/graphics/transparent_surface.h +++ b/graphics/transparent_surface.h @@ -45,6 +45,15 @@ namespace Graphics { +/** + * @defgroup graphics_transparent_surface Transparent surface + * @ingroup graphics + * + * @brief TransparentSurface class. + * + * @{ + */ + // Enums /** @brief The possible flipping parameters for the blit method. @@ -185,7 +194,7 @@ private: delete ptr; } };*/ - +/** @} */ } // End of namespace Graphics diff --git a/graphics/wincursor.h b/graphics/wincursor.h index 77d00d2d69c..1431d4a8944 100644 --- a/graphics/wincursor.h +++ b/graphics/wincursor.h @@ -34,6 +34,15 @@ class SeekableReadStream; namespace Graphics { +/** + * @defgroup graphics_wincursor Windows cursor + * @ingroup graphics + * + * @brief API related to Windows cursors. + * + * @{ + */ + /** * A structure holding an array of cursors from a single Windows Executable cursor group. * @@ -64,7 +73,7 @@ struct WinCursorGroup { * @note The calling code is responsible for deleting the returned pointer. */ Cursor *makeDefaultWinCursor(); - +/** @} */ } // End of namespace Graphics #endif diff --git a/graphics/yuv_to_rgb.h b/graphics/yuv_to_rgb.h index 8e1e6e40af3..fb383cce85e 100644 --- a/graphics/yuv_to_rgb.h +++ b/graphics/yuv_to_rgb.h @@ -21,8 +21,10 @@ */ /** - * @file - * YUV to RGB conversion. + * @defgroup graphics_yuvtorgb YUV to RGB conversion + * @ingroup graphics + * + * @brief Methods for converting YUV images into RGB surfaces. * * Used in video: * - BinkDecoder @@ -30,6 +32,7 @@ * - PSXStreamDecoder * - TheoraDecoder * - SVQ1Decoder + * @{ */ #ifndef GRAPHICS_YUV_TO_RGB_H @@ -129,7 +132,7 @@ private: int16 _colorTab[4 * 256]; // 2048 bytes bool _alphaMode; }; - + /** @} */ } // End of namespace Graphics #define YUVToRGBMan (::Graphics::YUVToRGBManager::instance())