From c21b8344e00e9b9c2a825a3c7d9fcb80c6ea94b7 Mon Sep 17 00:00:00 2001 From: Sadie del Solar Date: Mon, 1 Jul 2024 17:20:06 -0700 Subject: [PATCH] Codechange: Add doxygen comment for SetFont() in fontcache.cpp --- src/fontcache.cpp | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/fontcache.cpp b/src/fontcache.cpp index b4baf2a1ed..f8a8588903 100644 --- a/src/fontcache.cpp +++ b/src/fontcache.cpp @@ -171,6 +171,12 @@ void ResizeFont(FontSize font_size, uint size) if (_save_config) SaveToConfig(); } +/** + * Called to change a font or font size used by OpenTTD. + * @param font_size The FontSize(enum not pixel size) of the font to change. + * @param font The font name to use for this font. + * @param size The size(pixel size) to use for this font. + */ void SetFont(FontSize font_size, const std::string &font, uint size) { FontCacheSubSetting *setting = GetFontCacheSubSetting(font_size);