pidgin: Add documentation for functions in pidgintalkatu.h

Fri, 14 Dec 2018 17:21:16 -0600

author
Mike Ruprecht <cmaiku@gmail.com>
date
Fri, 14 Dec 2018 17:21:16 -0600
changeset 39394
837a999f0ee3
parent 39381
339b307b3e0b
child 39395
4c014de35067

pidgin: Add documentation for functions in pidgintalkatu.h

This patch adds documentation and therefore annotations to the
functions in pidgin/pidgintalkatu.h. Doing so silences a couple
of warnings when building our GObject introspection.

pidgin/pidgintalkatu.h file | annotate | diff | comparison | revisions
--- a/pidgin/pidgintalkatu.h	Fri Dec 14 08:25:23 2018 +0000
+++ b/pidgin/pidgintalkatu.h	Fri Dec 14 17:21:16 2018 -0600
@@ -37,7 +37,24 @@
 
 G_BEGIN_DECLS
 
+/**
+ * pidgin_talkatu_editor_new_for_connection:
+ * @pc: The connection for which the editor should be created
+ *
+ * Creates a new #TalkatuEditor appropriate for use with @pc.
+ *
+ * Returns: (transfer full): the new #TalkatuEditor
+ */
 GtkWidget *pidgin_talkatu_editor_new_for_connection(PurpleConnection *pc);
+
+/**
+ * pidgin_talkatu_buffer_new_for_connection:
+ * @pc: The connection for which the buffer should be created
+ *
+ * Creates a new #TalkatuBuffer appropriate for use with @pc.
+ *
+ * Returns: (transfer full): the new #TalkatuBuffer
+ */
 GtkTextBuffer *pidgin_talkatu_buffer_new_for_connection(PurpleConnection *pc);
 
 G_END_DECLS

mercurial