From fc56c6148f22d363a27c7a39d8d97a2d4d908a92 Mon Sep 17 00:00:00 2001
From: TheJackiMonster <thejackimonster@gmail.com>
Date: Tue, 19 Apr 2022 00:31:14 +0200
Subject: Added doxygen comments to some headers

Signed-off-by: TheJackiMonster <thejackimonster@gmail.com>
---
 src/ui.h | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

(limited to 'src/ui.h')

diff --git a/src/ui.h b/src/ui.h
index 3c06bcc..7547b0c 100644
--- a/src/ui.h
+++ b/src/ui.h
@@ -28,12 +28,33 @@
 #include <gtk-3.0/gtk/gtk.h>
 #include <libhandy-1/handy.h>
 
+/**
+ * Sets the text of a GtkLabel applying automatic utf8
+ * conversion.
+ *
+ * @param label Label
+ * @param text Non-utf8 text
+ */
 void
 ui_label_set_text(GtkLabel *label, const char *text);
 
+/**
+ * Sets the text of a GtkEntry applying automatic utf8
+ * conversion.
+ *
+ * @param entry Entry
+ * @param text Non-utf8 text
+ */
 void
 ui_entry_set_text(GtkEntry *entry, const char *text);
 
+/**
+ * Sets the text of a HdyAvatar applying automatic utf8
+ * conversion.
+ *
+ * @param avatar Avatar
+ * @param text Non-utf8 text
+ */
 void
 ui_avatar_set_text(HdyAvatar *avatar, const char *text);
 
-- 
cgit v1.2.3