From e5c14866bf1f64ab45259691f7615966a9db1c35 Mon Sep 17 00:00:00 2001 From: Alexander van Gessel Date: Sun, 5 Nov 2017 15:59:44 +0100 Subject: [PATCH] Improve doxygen comments --- src/sdl/utils.hpp | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/src/sdl/utils.hpp b/src/sdl/utils.hpp index 7f4a2d1d4cda..12fa9b97310a 100644 --- a/src/sdl/utils.hpp +++ b/src/sdl/utils.hpp @@ -212,7 +212,13 @@ surface submerge_alpha(const surface &surf, int depth, float alpha_base, float a */ surface light_surface(const surface &surf, const surface &lightmap); -/** Cross-fades a surface. */ +/** + * Cross-fades a surface. + * + * @param surf The source surface. + * @param depth The depth of the blurring. + * @return A new, blurred, neutral surface. + */ surface blur_surface(const surface &surf, int depth = 1); /** @@ -227,8 +233,9 @@ void blur_surface(surface& surf, SDL_Rect rect, int depth = 1); /** * Cross-fades a surface with alpha channel. * - * @todo FIXME: This is just an adapted copy-paste - * of the normal blur but with blur alpha channel too + * @param surf The source surface. + * @param depth The depth of the blurring. + * @return A new, blurred, neutral surface. */ surface blur_alpha_surface(const surface &surf, int depth = 1);