libui: Clarify that Font is only used for low-level glyph rendering

2023-09-11 19:14:17 +02:00 · 2023-09-11 19:14:17 +02:00 · 67eac983b5
commit 67eac983b5
parent 2643f050eb
1 changed files with 4 additions and 1 deletions
--- a/libui/include/ui/Font.h
+++ b/libui/include/ui/Font.h
@ -18,7 +18,10 @@
 namespace ui
 {
    /**
-     * @brief A class holding PSF font data, used for direct rendering of glyphs into a canvas.
+     * @brief A class holding PSF font data, used for low-level direct rendering of glyphs into a canvas.
+     *
+     * This class does not handle special characters such as tabs or newlines. For those, you should be using a more
+     * high-level component such as ui::Label instead.
     */
    class Font : public Shareable
    {