Convert pidgin from gtk-doc to gi-docgen
Testing Done:
Ran the docs locally and in convey.
Reviewed at https://reviews.imfreedom.org/r/1076/
--- a/convey.yaml Tue Oct 19 00:48:05 2021 -0500
+++ b/convey.yaml Tue Oct 19 02:49:28 2021 -0500
@@ -47,7 +47,7 @@
- build-docs/doc/reference/finch/finch/:finch3-docs
- build-docs/doc/reference/libpurple/html/:purple3-docs
- - build-docs/doc/reference/pidgin/html/:pidgin3-docs
+ - build-docs/doc/reference/pidgin/pidgin/:pidgin3-docs - build-docs/doc/reference/protocols/facebook/facebook/:facebook3-docs
--- a/doc/reference/pidgin/meson.build Tue Oct 19 00:48:05 2021 -0500
+++ b/doc/reference/pidgin/meson.build Tue Oct 19 02:49:28 2021 -0500
@@ -1,54 +1,36 @@
-# Header files or dirs to ignore when scanning. Use base file/dir names
-# Extra options to supply to gtkdoc-scan.
- '--deprecated-guards=PURPLE_DISABLE_DEPRECATED|PIDGIN_DISABLE_DEPRECATED',
- '--ignore-headers=' + ' '.join(ignore_hfiles),
-# Extra options to supply to gtkdoc-mkdb.
- '--ignore-files=' + ' '.join(ignore_hfiles),
+pidgin_doc_content_files = [ + 'signals_gtkaccount.md', -# Extra options to supply to fixxref
- '--extra-dir=../libpurple',
- input : 'version.xml.in',
- output : 'version.xml',
- configuration : version_conf)
+ pidgin_toml = configure_file( + input : 'pidgin.toml.in', + output : 'pidgin.toml', + configuration : version_conf, + install_dir : docs_dir / 'pidgin', -# Extra SGML files that are included by $(DOC_MAIN_XML_FILE).
- 'signals_gtkaccount.xml',
- 'signals_gtkblist.xml',
+ pidgin_doc = custom_target('pidgin-doc', + input : [ pidgin_toml, pidgin_gir[0] ], + '--output-dir=@OUTPUT@', + '--content-dir=@0@'.format(meson.current_source_dir()), + depend_files : [ pidgin_doc_content_files ], + build_by_default : true, + install_dir : docs_dir, -pidgin_doc = gnome.gtkdoc(DOC_MODULE,
- main_xml : DOC_MODULE + '-docs.xml',
- src_dir : libpidgin_inc,
- dependencies : libpidgin_dep,
- fixxref_args : fixxref_args,
- gobject_typesfile : DOC_MODULE + '.types',
- content_files : content_files)
--- a/doc/reference/pidgin/pidgin-docs.xml Tue Oct 19 00:48:05 2021 -0500
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,121 +0,0 @@
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
-<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
-<!ENTITY version SYSTEM "version.xml">
-<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
- <title>Pidgin Reference Manual</title>
- <title>Pidgin &version;</title>
- Pidgin is a GTK+ frontend to libpurple.
- <title>API Reference</title>
- <xi:include href="xml/gtkaccount.xml" />
- <xi:include href="xml/gtkblist.xml" />
- <xi:include href="xml/gtkconn.xml" />
- <xi:include href="xml/gtkconv.xml" />
- <xi:include href="xml/gtkconvwin.xml" />
- <xi:include href="xml/gtkdialogs.xml" />
- <xi:include href="xml/gtkdnd-hints.xml" />
- <xi:include href="xml/gtkicon-theme-loader.xml" />
- <xi:include href="xml/gtkicon-theme.xml" />
- <xi:include href="xml/gtkidle.xml" />
- <xi:include href="xml/gtkmedia.xml" />
- <xi:include href="xml/gtknotify.xml" />
- <xi:include href="xml/gtkpluginpref.xml" />
- <xi:include href="xml/gtkprivacy.xml" />
- <xi:include href="xml/gtkrequest.xml" />
- <xi:include href="xml/gtkroomlist.xml" />
- <xi:include href="xml/gtksavedstatuses.xml" />
- <xi:include href="xml/gtkstatus-icon-theme.xml" />
- <xi:include href="xml/gtkstatusbox.xml" />
- <xi:include href="xml/gtkutils.xml" />
- <xi:include href="xml/gtkwhiteboard.xml" />
- <xi:include href="xml/gtkxfer.xml" />
- <xi:include href="xml/minidialog.xml" />
- <xi:include href="xml/pidgin.xml" />
- <xi:include href="xml/pidginabout.xml" />
- <xi:include href="xml/pidginaccountactionsmenu.xml" />
- <xi:include href="xml/pidginaccountchooser.xml" />
- <xi:include href="xml/pidginaccountfilterconnected.xml" />
- <xi:include href="xml/pidginaccountfilterprotocol.xml" />
- <xi:include href="xml/pidginaccountsmenu.xml" />
- <xi:include href="xml/pidginaccountstore.xml" />
- <xi:include href="xml/pidginactiongroup.xml" />
- <xi:include href="xml/pidginapplication.xml" />
- <xi:include href="xml/pidginattachment.xml" />
- <xi:include href="xml/pidginavatar.xml" />
- <xi:include href="xml/pidgincellrendererexpander.xml" />
- <xi:include href="xml/pidginclosebutton.xml" />
- <xi:include href="xml/pidgincolor.xml" />
- <xi:include href="xml/pidgincontactcompletion.xml" />
- <xi:include href="xml/pidgincontactlist.xml" />
- <xi:include href="xml/pidginconversationwindow.xml" />
- <xi:include href="xml/pidgincore.xml" />
- <xi:include href="xml/pidgincredentialproviderrow.xml" />
- <xi:include href="xml/pidgincredentialspage.xml" />
- <xi:include href="xml/pidgindebug.xml" />
- <xi:include href="xml/pidgindialog.xml" />
- <xi:include href="xml/pidgingdkpixbuf.xml" />
- <xi:include href="xml/pidginiconname.xml" />
- <xi:include href="xml/pidgininfopane.xml" />
- <xi:include href="xml/pidgininvitedialog.xml" />
- <xi:include href="xml/pidginmenutray.xml" />
- <xi:include href="xml/pidginmessage.xml" />
- <xi:include href="xml/pidginmooddialog.xml" />
- <xi:include href="xml/pidginplugininfo.xml" />
- <xi:include href="xml/pidginpluginsdialog.xml" />
- <xi:include href="xml/pidginpluginsmenu.xml" />
- <xi:include href="xml/pidginprefs.xml" />
- <xi:include href="xml/pidginpresenceicon.xml" />
- <xi:include href="xml/pidginprotocolchooser.xml" />
- <xi:include href="xml/pidginprotocolstore.xml" />
- <xi:include href="xml/pidginscrollbook.xml" />
- <xi:include href="xml/pidginstock.xml" />
- <xi:include href="xml/pidginstylecontext.xml" />
- <xi:include href="xml/pidgintalkatu.xml" />
- <title>Purple-signals Reference</title>
- <xi:include href="signals_gtkaccount.xml" />
- <xi:include href="signals_gtkblist.xml" />
- <xi:include href="signals_gtkconv.xml" />
- <xi:include href="signals_gtklog.xml" />
- <title>Appendices</title>
- <index id="api-index-full">
- <title>API Index</title>
- <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
- <index id="api-deprecated">
- <title>Index of deprecated symbols</title>
- <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
- <title>Index of new symbols in 3.0.0</title>
- <xi:include href="xml/api-index-3.0.0.xml"><xi:fallback /></xi:include>
- <index id="api-2.10.0">
- <title>Index of new symbols in 2.10.0</title>
- <xi:include href="xml/api-index-2.10.0.xml"><xi:fallback /></xi:include>
- <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/reference/pidgin/pidgin.toml.in Tue Oct 19 02:49:28 2021 -0500
@@ -0,0 +1,66 @@
+version = "@PURPLE_VERSION@" +browse_url = "https://keep.imfreedom.org/pidgin/pidgin/" +repository_url = "https://keep.imfreedom.org/pidgin/pidgin/" +website_url = "https://keep.imfreedom.org/pidgin/pidgin/" +authors = "Pidgin Developers" +license = "GPL-2.0-or-later" +description = "Pidgin Universal Chat Client" +dependencies = [ "GLib-2.0", "GObject-2.0", "Gtk-3.0", "Purple-3.0", "GPlugin-1.0", "GPlugin-Gtk3-1.0", "Talkatu-0.0" ] + [dependencies."GLib-2.0"] + description = "General-purpose, portable utility library." + docs_url = "https://docs.gtk.org/glib/" + [dependencies."GObject-2.0"] + description = "The base type system library" + docs_url = "https://docs.gtk.org/gobject/" + [dependencies."Gtk-3.0"] + description = "The GTK toolkit" + docs_url = "https://docs.gtk.org/gtk3/" + [dependencies."Purple-3.0"] + description = "Purple Universal Chat Library" + docs_url = "https://docs.imfreedom.org/purple3/" + [dependencies."GPlugin-1.0"] + description = "GPlugin Plugin Library" + docs_urls = "https://docs.imfreedom.org/gplugin/" + [dependencies."GPlugin-Gtk3-1.0"] + description = "GPlugin Gtk3 Widget Library" + docs_urls = "https://docs.imfreedom.org/gplugin-gtk3/" + [dependencies."Talkatu-0.0"] + description = "Talkatu Gtk3 Chat Widgets" + docs_urls = "https://docs.imfreedom.org/talkatu/" +show_index_summary = true +show_class_hierarchy = true +base_url = "https://keep.imfreedom.org/pidgin/pidgin/file/default/" +# The same order will be used when generating the index + "signals_gtkaccount.md", +urlmap_file = "urlmap.js" --- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/reference/pidgin/signals_gtkaccount.md Tue Oct 19 02:49:28 2021 -0500
@@ -0,0 +1,21 @@
+void user_function(PurpleAccount *account, gpointer user_data); +Emitted when the settings for an account have been changed and saved. +: The account that has been modified. +: User data set when the signal handler was connected. --- a/doc/reference/pidgin/signals_gtkaccount.xml Tue Oct 19 00:48:05 2021 -0500
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,41 +0,0 @@
-<?xml version='1.0' encoding="ISO-8859-1"?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
-<chapter id="chapter-signals-gtkaccount">
-<title>Account signals</title>
-<refsect1 id="gtkaccounts.signals" role="signal_proto">
-<title role="signal_proto.title">List of signals</title>
- "<link linkend="gtkaccounts-account-modified">account-modified</link>"
-<refsect1 id="gtkaccounts.signal-details" role="signals">
-<title role="signals.title">Signal details</title>
-<refsect2 id="gtkaccounts-account-modified" role="signal">
- <title>The <literal>"account-modified"</literal> signal</title>
-void user_function (PurpleAccount *account,
-Emitted when the settings for an account have been changed and saved.
- <variablelist role="params">
- <term><parameter>account</parameter> :</term>
- <listitem><simpara>The account that has been modified.</simpara></listitem>
- <term><parameter>user_data</parameter> :</term>
- <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/reference/pidgin/signals_gtkblist.md Tue Oct 19 02:49:28 2021 -0500
@@ -0,0 +1,98 @@
+Title: Buddy List Signals +void user_function(PurpleBuddyList *blist, gpointer user_data); +Emitted when the buddy list is about to be hidden. +: User data set when the signal handler was connected. +void user_function(PurpleBuddyList *blist, gpointer user_data); +Emitted when the buddy list is about to be unhidden. +: User data set when the signal handler was connected. +void user_function(PurpleBuddyList *blist, gpointer user_data); +Emitted when the buddy list is created. +: User data set when the signal handler was connected. +void user_function(PurpleBlistNode *node, GString *text, gboolean full, gpointer user_data); +Emitted just before a tooltip is displayed. `text` is a standard GString, so +the plugin can modify the text that will be displayed. +: The blist node for the tooltip. +: A pointer to the text that will be displayed. +: Whether we're doing a full tooltip for the priority buddy or a compact +tooltip for a non-priority buddy. +: User data set when the signal handler was connected. +char *user_function(PurpleBuddy *buddy, gpointer user_data); +Emitted to allow plugins to handle markup within a buddy's name or to override +the default of no formatting for names shown in the buddy list. +: A pointer to the PupleBuddy that will be displayed. +: User data set when the signal handler was connected. +The text to display (must be allocated), or `NULL` if no changes to the default --- a/doc/reference/pidgin/signals_gtkblist.xml Tue Oct 19 00:48:05 2021 -0500
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,146 +0,0 @@
-<?xml version='1.0' encoding="ISO-8859-1"?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
-<chapter id="chapter-signals-gtkblist">
-<title>Buddy List signals</title>
-<refsect1 id="gtkblist.signals" role="signal_proto">
-<title role="signal_proto.title">List of signals</title>
- "<link linkend="gtkblist-gtkblist-hiding">gtkblist-hiding</link>"
- "<link linkend="gtkblist-gtkblist-unhiding">gtkblist-unhiding</link>"
- "<link linkend="gtkblist-gtkblist-created">gtkblist-created</link>"
- "<link linkend="gtkblist-drawing-tooltip">drawing-tooltip</link>"
- "<link linkend="gtkblist-drawing-buddy">drawing-buddy</link>"
-<refsect1 id="gtkblist.signal-details" role="signals">
-<title role="signals.title">Signal details</title>
-<refsect2 id="gtkblist-gtkblist-hiding" role="signal">
- <title>The <literal>"gtkblist-hiding"</literal> signal</title>
-void user_function (PurpleBuddyList *blist,
-Emitted when the buddy list is about to be hidden.
- <variablelist role="params">
- <term><parameter>blist</parameter> :</term>
- <listitem><simpara>The buddy list.</simpara></listitem>
- <term><parameter>user_data</parameter> :</term>
- <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
-<refsect2 id="gtkblist-gtkblist-unhiding" role="signal">
- <title>The <literal>"gtkblist-unhiding"</literal> signal</title>
-void user_function (PurpleBuddyList *blist,
-Emitted when the buddy list is about to be unhidden.
- <variablelist role="params">
- <term><parameter>blist</parameter> :</term>
- <listitem><simpara>The buddy list.</simpara></listitem>
- <term><parameter>user_data</parameter> :</term>
- <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
-<refsect2 id="gtkblist-gtkblist-created" role="signal">
- <title>The <literal>"gtkblist-created"</literal> signal</title>
-void user_function (PurpleBuddyList *blist,
-Emitted when the buddy list is created.
- <variablelist role="params">
- <term><parameter>blist</parameter> :</term>
- <listitem><simpara>The buddy list.</simpara></listitem>
- <term><parameter>user_data</parameter> :</term>
- <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
-<refsect2 id="gtkblist-drawing-tooltip" role="signal">
- <title>The <literal>"drawing-tooltip"</literal> signal</title>
-void user_function (PurpleBlistNode *node,
-Emitted just before a tooltip is displayed. <literal>text</literal> is a standard GString, so the plugin can modify the text that will be displayed.
-Make sure to free <literal>*text</literal> before you replace it!
- <variablelist role="params">
- <term><parameter>node</parameter> :</term>
- <listitem><simpara>The blist node for the tooltip.</simpara></listitem>
- <term><parameter>text</parameter> :</term>
- <listitem><simpara>A pointer to the text that will be displayed.</simpara></listitem>
- <term><parameter>full</parameter> :</term>
- <listitem><simpara>Whether we're doing a full tooltip for the priority buddy or a compact tooltip for a non-priority buddy.</simpara></listitem>
- <term><parameter>user_data</parameter> :</term>
- <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
-<refsect2 id="gtkblist-drawing-buddy" role="signal">
- <title>The <literal>"drawing-buddy"</literal> signal</title>
-char * user_function (PurpleBuddy *buddy,
-Emitted to allow plugins to handle markup within a buddy's name or to override the default of no formatting for names shown in the buddy list.
- <variablelist role="params">
- <term><parameter>buddy</parameter> :</term>
- <listitem><simpara>A pointer to the PurpleBuddy that will be displayed.</simpara></listitem>
- <term><parameter>user_data</parameter> :</term>
- <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
- <term><emphasis>Returns</emphasis> :</term>
- <listitem><simpara>The text to display (must be allocated), or <literal>NULL</literal> if no changes to the default behavior are desired.</simpara></listitem>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/reference/pidgin/signals_gtkconv.md Tue Oct 19 02:49:28 2021 -0500
@@ -0,0 +1,189 @@
+Title: Conversation Signals +Slug: conversation-signals +user_function(PurpleAccount *account, + PurpleConversation *conv, + PurpleMessageFlags flags, +Emitted just before a message is displayed in an IM conversation. `message` is +a pointer to a string, so the plugin can replace the message that will be +displayed. This can also be used to cancel displaying a message by returning +> **NOTE:** Make sure to free `*message` before you replace it! +: A pointer to the message. +: Flags for this message. +: User data set when the signal handler was connected. +`TRUE` if the message should be canceled, or `FALSE` otherwise. +user_function(PurpleAccount *account, + PurpleConversation *conv, + PurpleMessageFlags flags, +Emitted after a message is displayed in an IM conversation. +: Flags for this message. +: User data set when the signal handler was connected. +user_function(PurpleAccount *account, + PurpleConversation *conv, + PurpleMessageFlags flags, +Emitted just before a message is displayed in a chat. `message` is a pointer to +a string, so the plugin can replace the message that will be displayed. This +can also be used to cancel displaying a message by returning `TRUE`. +> **NOTE:** Make sure to free `*message` before you replace it! +: The account the message is being displayed and sent on. +: A pointer to the message that will be displayed and sent. +: The conversation the message is being displayed and sent on. +: Flags for this message. +: User data set when the signal handler was connected. +`TRUE` if the message should be canceled, or `FALSE` otherwise. +user_function(PurpleAccount *account, + PurpleConversation *conv, + PurpleMessageFlags flags, +Emitted after a message is displayed in a chat conversation. +: The account the message is being displayed and sent on. +: A pointer to the message that will be displayed and sent. +: The conversation the message is being displayed and sent on. +: Flags for this message. +: User data set when the signal handler was connected. +### conversation-switched +void user_function(PurpleConversation *conv, gpointer user_data); +Emitted when a window switched from one conversation to another. +: The now active conversation. +: User data set when the signal handler was connected. +### conversation-displayed +void user_function(PidginConversation *gtkconv, gpointer user_data); +Emitted right after the Pidgin UI is attached to a new conversation. +: The PidginConversation. +: User data set when the signal handler was connected. --- a/doc/reference/pidgin/signals_gtkconv.xml Tue Oct 19 00:48:05 2021 -0500
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,273 +0,0 @@
-<?xml version='1.0' encoding="ISO-8859-1"?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
-<chapter id="chapter-signals-gtkconv">
-<title>Conversation signals</title>
-<refsect1 id="gtkconvs.signals" role="signal_proto">
-<title role="signal_proto.title">List of signals</title>
- "<link linkend="gtkconvs-conversation-dragging">conversation-dragging</link>"
- "<link linkend="gtkconvs-displaying-im-msg">displaying-im-msg</link>"
- "<link linkend="gtkconvs-displayed-im-msg">displayed-im-msg</link>"
- "<link linkend="gtkconvs-displaying-chat-msg">displaying-chat-msg</link>"
- "<link linkend="gtkconvs-displayed-chat-msg">displayed-chat-msg</link>"
- "<link linkend="gtkconvs-conversation-switched">conversation-switched</link>"
- "<link linkend="gtkconvs-conversation-displayed">conversation-displayed</link>"
-<refsect1 id="gtkconvs.signal-details" role="signals">
-<title role="signals.title">Signal details</title>
-<refsect2 id="gtkconvs-conversation-dragging" role="signal">
- <title>The <literal>"conversation-dragging"</literal> signal</title>
-void user_function (PidginConvWindow *source,
- PidginConvWindow *destination,
-Emitted when a conversation is being drag and dropped between windows.
- <variablelist role="params">
- <term><parameter>source</parameter> :</term>
- <listitem><simpara>The window where the conversation is.</simpara></listitem>
- <term><parameter>destination</parameter> :</term>
- <listitem><simpara>The window where the conversation will be moved to.</simpara></listitem>
- <term><parameter>user_data</parameter> :</term>
- <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
-<refsect2 id="gtkconvs-displaying-im-msg" role="signal">
- <title>The <literal>"displaying-im-msg"</literal> signal</title>
-gboolean user_function (PurpleAccount *account,
- PurpleConversation *conv,
- PurpleMessageFlags flags,
-Emitted just before a message is displayed in an IM conversation. <literal>message</literal> is a pointer to a string, so the plugin can replace the message that will be displayed. This can also be used to cancel displaying a message by returning <literal>TRUE</literal>.
-Make sure to free <literal>*message</literal> before you replace it!
- <variablelist role="params">
- <term><parameter>account</parameter> :</term>
- <listitem><simpara>The account.</simpara></listitem>
- <term><parameter>who</parameter> :</term>
- <listitem><simpara>The name of the user.</simpara></listitem>
- <term><parameter>message</parameter> :</term>
- <listitem><simpara>A pointer to the message.</simpara></listitem>
- <term><parameter>conv</parameter> :</term>
- <listitem><simpara>The conversation.</simpara></listitem>
- <term><parameter>flags</parameter> :</term>
- <listitem><simpara>Flags for this message.</simpara></listitem>
- <term><parameter>user_data</parameter> :</term>
- <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
- <term><emphasis>Returns</emphasis> :</term>
- <listitem><simpara><literal>TRUE</literal> if the message should be canceled, or <literal>FALSE</literal> otherwise.</simpara></listitem>
-<refsect2 id="gtkconvs-displayed-im-msg" role="signal">
- <title>The <literal>"displayed-im-msg"</literal> signal</title>
-void user_function (PurpleAccount *account,
- PurpleConversation *conv,
- PurpleMessageFlags flags,
-Emitted after a message is displayed in an IM conversation.
- <variablelist role="params">
- <term><parameter>account</parameter> :</term>
- <listitem><simpara>The account.</simpara></listitem>
- <term><parameter>who</parameter> :</term>
- <listitem><simpara>The name of the user.</simpara></listitem>
- <term><parameter>message</parameter> :</term>
- <listitem><simpara>The message.</simpara></listitem>
- <term><parameter>conv</parameter> :</term>
- <listitem><simpara>The conversation.</simpara></listitem>
- <term><parameter>flags</parameter> :</term>
- <listitem><simpara>Flags for this message.</simpara></listitem>
- <term><parameter>user_data</parameter> :</term>
- <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
-<refsect2 id="gtkconvs-displaying-chat-msg" role="signal">
- <title>The <literal>"displaying-chat-msg"</literal> signal</title>
-gboolean user_function (PurpleAccount *account,
- PurpleConversation *conv,
- PurpleMessageFlags flags,
-Emitted just before a message is displayed in a chat. <literal>message</literal> is a pointer to a string, so the plugin can replace the message that will be displayed. This can also be used to cancel displaying a message by returning <literal>TRUE</literal>.
-Make sure to free <literal>*message</literal> before you replace it!
- <variablelist role="params">
- <term><parameter>account</parameter> :</term>
- <listitem><simpara>The account the message is being displayed and sent on.</simpara></listitem>
- <term><parameter>who</parameter> :</term>
- <listitem><simpara>The name of the user.</simpara></listitem>
- <term><parameter>message</parameter> :</term>
- <listitem><simpara>A pointer to the message that will be displayed and sent.</simpara></listitem>
- <term><parameter>conv</parameter> :</term>
- <listitem><simpara>The conversation the message is being displayed and sent on.</simpara></listitem>
- <term><parameter>flags</parameter> :</term>
- <listitem><simpara>Flags for this message.</simpara></listitem>
- <term><parameter>user_data</parameter> :</term>
- <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
- <term><emphasis>Returns</emphasis> :</term>
- <listitem><simpara><literal>TRUE</literal> if the message should be canceled, or <literal>FALSE</literal> otherwise.</simpara></listitem>
-<refsect2 id="gtkconvs-displayed-chat-msg" role="signal">
- <title>The <literal>"displayed-chat-msg"</literal> signal</title>
-void user_function (PurpleAccount *account,
- PurpleConversation *conv,
- PurpleMessageFlags flags,
-Emitted after a message is displayed in a chat conversation.
- <variablelist role="params">
- <term><parameter>account</parameter> :</term>
- <listitem><simpara>The account the message is being displayed and sent on.</simpara></listitem>
- <term><parameter>who</parameter> :</term>
- <listitem><simpara>The name of the user.</simpara></listitem>
- <term><parameter>message</parameter> :</term>
- <listitem><simpara>A pointer to the message that will be displayed and sent.</simpara></listitem>
- <term><parameter>conv</parameter> :</term>
- <listitem><simpara>The conversation the message is being displayed and sent on.</simpara></listitem>
- <term><parameter>flags</parameter> :</term>
- <listitem><simpara>Flags for this message.</simpara></listitem>
- <term><parameter>user_data</parameter> :</term>
- <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
-<refsect2 id="gtkconvs-conversation-switched" role="signal">
- <title>The <literal>"conversation-switched"</literal> signal</title>
-void user_function (PurpleConversation *conv,
-Emitted when a window switched from one conversation to another.
- <variablelist role="params">
- <term><parameter>new_conv</parameter> :</term>
- <listitem><simpara>The now active conversation.</simpara></listitem>
- <term><parameter>user_data</parameter> :</term>
- <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
-<refsect2 id="gtkconvs-conversation-displayed" role="signal">
- <title>The <literal>"conversation-displayed"</literal> signal</title>
-void user_function (PidginConversation *gtkconv,
-Emitted right after the Pidgin UI is attached to a new conversation.
- <variablelist role="params">
- <term><parameter>gtkconv</parameter> :</term>
- <listitem><simpara>The PidginConversation.</simpara></listitem>
- <term><parameter>user_data</parameter> :</term>
- <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
--- a/doc/reference/pidgin/signals_gtklog.xml Tue Oct 19 00:48:05 2021 -0500
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,46 +0,0 @@
-<?xml version='1.0' encoding="ISO-8859-1"?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
-<chapter id="chapter-signals-gtklog">
-<title>Log signals</title>
-<refsect1 id="gtklogs.signals" role="signal_proto">
-<title role="signal_proto.title">List of signals</title>
- "<link linkend="gtklogs-log-displaying">log-displaying</link>"
-<refsect1 id="gtklogs.signal-details" role="signals">
-<title role="signals.title">Signal details</title>
-<refsect2 id="gtklogs-log-displaying" role="signal">
- <title>The <literal>"log-displaying"</literal> signal</title>
-void user_function (PidginLogViewer *viewer,
-Emitted when a log is being displayed.
- <variablelist role="params">
- <term><parameter>viewer</parameter> :</term>
- <listitem><simpara>The log viewer.</simpara></listitem>
- <term><parameter>log</parameter> :</term>
- <listitem><simpara>The log being displayed.</simpara></listitem>
- <term><parameter>user_data</parameter> :</term>
- <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/reference/pidgin/urlmap.js Tue Oct 19 02:49:28 2021 -0500
@@ -0,0 +1,13 @@
+// SPDX-FileCopyrightText: 2021 GNOME Foundation +// SPDX-License-Identifier: LGPL-2.1-or-later +// A map between namespaces and base URLs for their online documentation + [ 'GLib', 'https://docs.gtk.org/glib/' ], + [ 'GObject', 'https://docs.gtk.org/gobject/' ], + [ 'GPlugin', 'https://docs.imfreedom.org/gplugin/' ], + [ 'GPlugin-Gtk3', 'https://docs.imfreedom.org/gplugin-gtk3/' ], + [ 'Gtk', 'https://docs.gtk.org/gtk3/' ], + [ 'Purple3', 'https://docs.imfreedom.org/purple3/' ], + [ 'Talkatu', 'https://docs.imfreedom.org/talkatu/' ], --- a/doc/reference/pidgin/version.xml.in Tue Oct 19 00:48:05 2021 -0500
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,1 +0,0 @@
--- a/pidgin/gtkaccount.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/gtkaccount.h Tue Oct 19 02:49:28 2021 -0500
@@ -25,13 +25,6 @@
#ifndef _PIDGINACCOUNT_H_
#define _PIDGINACCOUNT_H_
- * @section_id: pidgin-gtkaccount
- * @short_description: <filename>gtkaccount.h</filename>
- * @title: Account Editor UI
- * @see_also: <link linkend="chapter-signals-gtkaccount">Account signals</link>
--- a/pidgin/gtkblist.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/gtkblist.h Tue Oct 19 02:49:28 2021 -0500
@@ -21,13 +21,6 @@
- * @section_id: pidgin-gtkblist
- * @short_description: <filename>gtkblist.h</filename>
- * @title: Buddy List API
- * @see_also: <link linkend="chapter-signals-gtkblist">Buddy List signals</link>
@@ -121,11 +114,6 @@
**************************************************************************/
- * pidgin_buddy_list_get_type:
- * Returns: The #GType for the #PidginBuddyList boxed structure.
G_DECLARE_FINAL_TYPE(PidginBuddyList, pidgin_buddy_list, PIDGIN, BUDDY_LIST,
--- a/pidgin/gtkconn.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/gtkconn.h Tue Oct 19 02:49:28 2021 -0500
@@ -25,12 +25,6 @@
- * @section_id: pidgin-gtkconn
- * @short_description: <filename>gtkconn.h</filename>
- * @title: Connection API
--- a/pidgin/gtkconv.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/gtkconv.h Tue Oct 19 02:49:28 2021 -0500
@@ -25,13 +25,6 @@
#ifndef _PIDGIN_CONVERSATION_H_
#define _PIDGIN_CONVERSATION_H_
- * @section_id: pidgin-gtkconv
- * @short_description: <filename>gtkconv.h</filename>
- * @title: Conversation API
- * @see_also: <link linkend="chapter-signals-gtkconv">Conversation signals</link>
typedef struct _PidginImPane PidginImPane;
typedef struct _PidginChatPane PidginChatPane;
--- a/pidgin/gtkconvwin.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/gtkconvwin.h Tue Oct 19 02:49:28 2021 -0500
@@ -25,12 +25,6 @@
#ifndef _PIDGIN_CONVERSATION_WINDOW_H_
#define _PIDGIN_CONVERSATION_WINDOW_H_
- * @section_id: pidgin-gtkconvwin
- * @short_description: <filename>gtkconvwin.h</filename>
- * @title: Conversation Window API
--- a/pidgin/gtkdialogs.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/gtkdialogs.h Tue Oct 19 02:49:28 2021 -0500
@@ -25,12 +25,6 @@
#ifndef _PIDGINDIALOGS_H_
#define _PIDGINDIALOGS_H_
- * @section_id: pidgin-gtkdialogs
- * @short_description: <filename>gtkdialogs.h</filename>
- * @title: Pidgin Dialogs
--- a/pidgin/gtkdnd-hints.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/gtkdnd-hints.h Tue Oct 19 02:49:28 2021 -0500
@@ -23,12 +23,6 @@
#ifndef _PIDGIN_DND_HINTS_H_
#define _PIDGIN_DND_HINTS_H_
- * @section_id: pidgin-gtkdnd-hints
- * @short_description: <filename>gtkdnd-hints.h</filename>
- * @title: Drag-and-Drop Arrow Hints
--- a/pidgin/gtkicon-theme-loader.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/gtkicon-theme-loader.h Tue Oct 19 02:49:28 2021 -0500
@@ -25,12 +25,6 @@
#ifndef PIDGIN_ICON_THEME_LOADER_H
#define PIDGIN_ICON_THEME_LOADER_H
- * SECTION:gtkicon-theme-loader
- * @section_id: pidgin-gtkicon-theme-loader
- * @short_description: <filename>gtkicon-theme-loader.h</filename>
- * @title: Pidgin Icon Theme Loader Class
@@ -44,11 +38,6 @@
/**************************************************************************/
- * pidgin_icon_theme_loader_get_type:
- * Returns: The #GType for an icon theme loader.
G_DECLARE_FINAL_TYPE(PidginIconThemeLoader, pidgin_icon_theme_loader, PIDGIN,
ICON_THEME_LOADER, PurpleThemeLoader)
--- a/pidgin/gtkicon-theme.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/gtkicon-theme.h Tue Oct 19 02:49:28 2021 -0500
@@ -25,12 +25,6 @@
#ifndef PIDGIN_ICON_THEME_H
#define PIDGIN_ICON_THEME_H
- * SECTION:gtkicon-theme
- * @section_id: pidgin-gtkicon-theme
- * @short_description: <filename>gtkicon-theme.h</filename>
- * @title: Icon Theme Class
@@ -49,11 +43,6 @@
/**************************************************************************/
- * pidgin_icon_theme_get_type:
- * Returns: The #GType for an icon theme.
G_DECLARE_DERIVABLE_TYPE(PidginIconTheme, pidgin_icon_theme, PIDGIN,
--- a/pidgin/gtkidle.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/gtkidle.h Tue Oct 19 02:49:28 2021 -0500
@@ -25,12 +25,6 @@
- * @section_id: pidgin-gtkidle
- * @short_description: <filename>gtkidle.h</filename>
--- a/pidgin/gtkmedia.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/gtkmedia.h Tue Oct 19 02:49:28 2021 -0500
@@ -25,12 +25,6 @@
- * @section_id: pidgin-gtkmedia
- * @short_description: <filename>gtkmedia.h</filename>
--- a/pidgin/gtknotify.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/gtknotify.h Tue Oct 19 02:49:28 2021 -0500
@@ -25,12 +25,6 @@
- * @section_id: pidgin-gtknotify
- * @short_description: <filename>gtknotify.h</filename>
- * @title: Notification API
--- a/pidgin/gtkpluginpref.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/gtkpluginpref.h Tue Oct 19 02:49:28 2021 -0500
@@ -26,12 +26,6 @@
#ifndef _PIDGINPLUGINPREF_H_
#define _PIDGINPLUGINPREF_H_
- * SECTION:gtkpluginpref
- * @section_id: pidgin-gtkpluginpref
- * @short_description: <filename>gtkpluginpref.h</filename>
- * @title: Plugin Preferences
--- a/pidgin/gtkprivacy.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/gtkprivacy.h Tue Oct 19 02:49:28 2021 -0500
@@ -25,12 +25,6 @@
#ifndef _PIDGINPRIVACY_H_
#define _PIDGINPRIVACY_H_
- * @section_id: pidgin-gtkprivacy
- * @short_description: <filename>gtkprivacy.h</filename>
--- a/pidgin/gtkrequest.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/gtkrequest.h Tue Oct 19 02:49:28 2021 -0500
@@ -25,12 +25,6 @@
#ifndef _PIDGINREQUEST_H_
#define _PIDGINREQUEST_H_
- * @section_id: pidgin-gtkrequest
- * @short_description: <filename>gtkrequest.h</filename>
--- a/pidgin/gtkroomlist.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/gtkroomlist.h Tue Oct 19 02:49:28 2021 -0500
@@ -25,12 +25,6 @@
#ifndef _PIDGINROOMLIST_H_
#define _PIDGINROOMLIST_H_
- * @section_id: pidgin-gtkroomlist
- * @short_description: <filename>gtkroomlist.h</filename>
--- a/pidgin/gtksavedstatuses.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/gtksavedstatuses.h Tue Oct 19 02:49:28 2021 -0500
@@ -25,12 +25,6 @@
#ifndef _PIDGINSAVEDSTATUSES_H_
#define _PIDGINSAVEDSTATUSES_H_
- * SECTION:gtksavedstatuses
- * @section_id: pidgin-gtksavedstatuses
- * @short_description: <filename>gtksavedstatuses.h</filename>
- * @title: Saved Status Editor UI
--- a/pidgin/gtkstatus-icon-theme.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/gtkstatus-icon-theme.h Tue Oct 19 02:49:28 2021 -0500
@@ -25,12 +25,6 @@
#ifndef PIDGIN_STATUS_ICON_THEME_H
#define PIDGIN_STATUS_ICON_THEME_H
- * SECTION:gtkstatus-icon-theme
- * @section_id: pidgin-gtkstatus-icon-theme
- * @short_description: <filename>gtkstatus-icon-theme.h</filename>
- * @title: Pidgin Icon Theme Class
#include "gtkicon-theme.h"
@@ -42,11 +36,6 @@
/**************************************************************************/
- * pidgin_status_icon_theme_get_type:
- * Returns: The #GType for a status icon theme.
G_DECLARE_FINAL_TYPE(PidginStatusIconTheme, pidgin_status_icon_theme, PIDGIN,
STATUS_ICON_THEME, PidginIconTheme)
--- a/pidgin/gtkstatusbox.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/gtkstatusbox.h Tue Oct 19 02:49:28 2021 -0500
@@ -27,13 +27,6 @@
#ifndef PIDGIN_STATUS_BOX_H
#define PIDGIN_STATUS_BOX_H
- * @section_id: pidgin-gtkstatusbox
- * @short_description: <filename>gtkstatusbox.h</filename>
- * @title: Status Selection Widget
--- a/pidgin/gtkutils.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/gtkutils.h Tue Oct 19 02:49:28 2021 -0500
@@ -25,12 +25,6 @@
- * @section_id: pidgin-gtkutils
- * @short_description: <filename>gtkutils.h</filename>
- * @title: Utility functions
--- a/pidgin/gtkwhiteboard.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/gtkwhiteboard.h Tue Oct 19 02:49:28 2021 -0500
@@ -25,12 +25,6 @@
#ifndef _PIDGINWHITEBOARD_H_
#define _PIDGINWHITEBOARD_H_
- * SECTION:gtkwhiteboard
- * @section_id: pidgin-gtkwhiteboard
- * @short_description: <filename>gtkwhiteboard.h</filename>
- * @title: Whiteboard Frontend
--- a/pidgin/gtkxfer.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/gtkxfer.h Tue Oct 19 02:49:28 2021 -0500
@@ -25,12 +25,6 @@
- * @section_id: pidgin-gtkxfer
- * @short_description: <filename>gtkxfer.h</filename>
- * @title: File Transfer UI
--- a/pidgin/meson.build Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/meson.build Tue Oct 19 02:49:28 2021 -0500
@@ -311,25 +311,17 @@
introspection_sources = libpidgin_headers + libpidgin_prefs_headers
- Pidgin_gir_includes = [
- 'GObject-2.0', 'Gtk-3.0', 'GPlugin-1.0', 'GPluginGtk3-1.0',
- # subproject needs to be before libpurple in the repo so that
- # meson will use our variables and not try to discover them from
- gnome.generate_gir(libpidgin,
+ pidgin_gir = gnome.generate_gir(libpidgin, sources : introspection_sources,
- includes : Pidgin_gir_includes,
+ includes : ['GLib-2.0', 'GObject-2.0', 'Gtk-3.0'], symbol_prefix : 'pidgin',
identifier_prefix : 'Pidgin',
export_packages : 'pidgin-@0@'.format(purple_major_version),
nsversion : '@0@.@1@'.format(purple_major_version,
- dependencies : [gplugin_dep, gplugin_gtk_dep, talkatu_dep],
+ dependencies : [gplugin_dep, gplugin_gtk_dep, talkatu_dep, libpurple_dep], extra_args : ['-DPIDGIN_COMPILATION', '--quiet'])
--- a/pidgin/minidialog.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/minidialog.h Tue Oct 19 02:49:28 2021 -0500
@@ -25,12 +25,6 @@
#ifndef PIDGIN_MINI_DIALOG_H
#define PIDGIN_MINI_DIALOG_H
- * @section_id: pidgin-minidialog
- * @short_description: <filename>minidialog.h</filename>
- * @title: Mini Dialog Widget
@@ -95,12 +89,6 @@
GtkButton *button, gpointer user_data);
- * pidgin_mini_dialog_get_type:
- * Get the GType of #PidginMiniDialog.
* pidgin_mini_dialog_new:
* Creates a new #PidginMiniDialog with a #GtkIconTheme icon. This is a
--- a/pidgin/pidginabout.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/pidginabout.h Tue Oct 19 02:49:28 2021 -0500
@@ -27,13 +27,6 @@
- * @section_id: pidgin-about
- * @short_description: <filename>pidginabout.h</filename>
--- a/pidgin/pidginaccountactionsmenu.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/pidginaccountactionsmenu.h Tue Oct 19 02:49:28 2021 -0500
@@ -27,22 +27,19 @@
#ifndef PIDGIN_ACCOUNT_ACTIONS_MENU_H
#define PIDGIN_ACCOUNT_ACTIONS_MENU_H
- * SECTION:pidginaccountactionsmenu
- * @section_id: pidgin-account-actions-menu
- * @short_description: A menu for managing account actions
- * @title: Accounts Actions Menu
- * #PidginAccountActionsMenu is a #GtkMenu that provides an interface for users
- * to edit accounts and activate the account's actions.
+ * PidginAccountActionsMenu: + * A #GtkMenu that provides an interface for users to edit accounts and + * activate the account's actions. #define PIDGIN_TYPE_ACCOUNT_ACTIONS_MENU (pidgin_account_actions_menu_get_type())
G_DECLARE_FINAL_TYPE(PidginAccountActionsMenu, pidgin_account_actions_menu,
PIDGIN, ACCOUNT_ACTIONS_MENU, GtkMenu)
--- a/pidgin/pidginaccountchooser.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/pidginaccountchooser.h Tue Oct 19 02:49:28 2021 -0500
@@ -25,12 +25,6 @@
#ifndef PIDGIN_ACCOUNT_CHOOSER_H
#define PIDGIN_ACCOUNT_CHOOSER_H
- * SECTION:pidginaccountchooser
- * @section_id: pidgin-account-chooser
- * @short_description: A #GtkComboBox for choosing accounts
- * @title: Pidgin Account Chooser Combo Box Widget
--- a/pidgin/pidginaccountfilterconnected.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/pidginaccountfilterconnected.h Tue Oct 19 02:49:28 2021 -0500
@@ -23,21 +23,20 @@
#ifndef PIDGIN_ACCOUNT_FILTER_CONNECTED_H
#define PIDGIN_ACCOUNT_FILTER_CONNECTED_H
- * SECTION: pidginaccountfilterconnected
- * @section_id: pidgin-account-filter-connected
- * @short_description: A GtkTreeModelFilter that displays connected accounts.
- * @title: Account Connected Filter
+ * PidginAccountFilterConnected: * #PidginAccountFilterConnected is a #GtkTreeModelFilter that will only show
* accounts that are connected. It's intended to be used with
#define PIDGIN_TYPE_ACCOUNT_FILTER_CONNECTED pidgin_account_filter_connected_get_type()
G_DECLARE_FINAL_TYPE(PidginAccountFilterConnected,
pidgin_account_filter_connected, PIDGIN,
--- a/pidgin/pidginaccountfilterprotocol.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/pidginaccountfilterprotocol.h Tue Oct 19 02:49:28 2021 -0500
@@ -23,21 +23,20 @@
#ifndef PIDGIN_ACCOUNT_FILTER_PROTOCOL_H
#define PIDGIN_ACCOUNT_FILTER_PROTOCOL_H
- * SECTION:pidginaccountfilterprotocol
- * @section_id: pidgin-account-filter-protocol
- * @short_description: A GtkTreeModelFilter that displays the given protocol.
- * @title: Account Protocol Filter
+ * PidginAccountFilterProtocol: * #PidginAccountFilterProtocol is a #GtkTreeModelFilter that will only show
* accounts for the given protocol. It's intended to be used with
#define PIDGIN_TYPE_ACCOUNT_FILTER_PROTOCOL pidgin_account_filter_protocol_get_type()
G_DECLARE_FINAL_TYPE(PidginAccountFilterProtocol,
pidgin_account_filter_protocol, PIDGIN,
@@ -67,6 +66,8 @@
* Gets the ID of the protocol that @filter is filtering for.
* Returns: The Protocol ID that @filter is filtering for.
const gchar *pidgin_account_filter_protocol_get_protocol_id(PidginAccountFilterProtocol *filter);
--- a/pidgin/pidginaccountsmenu.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/pidginaccountsmenu.h Tue Oct 19 02:49:28 2021 -0500
@@ -27,23 +27,22 @@
#ifndef PIDGIN_ACCOUNTS_MENU_H
#define PIDGIN_ACCOUNTS_MENU_H
- * SECTION:pidginaccountsmenu
- * @section_id: pidgin-accounts-menu
- * @short_description: A menu for managing accounts and their actions
- * @title: Accounts Menu
* #PidginAccountsMenu is a #GtkMenu that provides an interface to users to open
* the account manager as well as activate account actions.
* It manages itself as accounts are created/deleted and enabled/disabled and
* can be added as a submenu to any #GtkMenuItem.
#define PIDGIN_TYPE_ACCOUNTS_MENU (pidgin_accounts_menu_get_type())
G_DECLARE_FINAL_TYPE(PidginAccountsMenu, pidgin_accounts_menu, PIDGIN,
--- a/pidgin/pidginaccountstore.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/pidginaccountstore.h Tue Oct 19 02:49:28 2021 -0500
@@ -23,21 +23,20 @@
#ifndef PIDGIN_ACCOUNT_STORE_H
#define PIDGIN_ACCOUNT_STORE_H
- * SECTION:pidginaccountstore
- * @section_id: pidgin-account-store
- * @short_description: A GtkListStore that keeps track of accounts
- * @title: Account Store
* #PidginAccountStore is a #GtkListStore that automatically keeps track of
* what accounts are currently available in libpurple. It's intended to be
* used any time that you need to present an account selection to the user.
* PidginAccountStoreColumn:
* @PIDGIN_ACCOUNT_STORE_COLUMN_ACCOUNT: This column holds a reference to the
--- a/pidgin/pidginactiongroup.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/pidginactiongroup.h Tue Oct 19 02:49:28 2021 -0500
@@ -27,21 +27,20 @@
#ifndef PIDGIN_ACTION_GROUP_H
#define PIDGIN_ACTION_GROUP_H
- * SECTION:pidginactiongroup
- * @section_id: pidgin-action-group
- * @short_description: An action group for Pidgin
* A #GSimpleActionGroup containing most of our actions. A lot of this will
* need to be added to the #GtkApplication, but I didn't want to do that part
* quite yet, so I created this instead.
* PIDGIN_ACTION_SHOW_BUDDY_ICONS:
--- a/pidgin/pidginapplication.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/pidginapplication.h Tue Oct 19 02:49:28 2021 -0500
@@ -27,21 +27,20 @@
#ifndef PIDGIN_APPLICATION_H
#define PIDGIN_APPLICATION_H
- * SECTION:pidginapplication
- * @section_id: pidgin-application
- * @short_description: A #GtkApplication subclass for Pidgin.
- * @title: Pidgin Application
- * #PidginApplication is a subclass of #GtkApplication that holds all of the
- * application wide actions.
+ * #PidginApplication is a subclass of #GtkApplication that holds all of the + * application wide actions. #define PIDGIN_TYPE_APPLICATION (pidgin_application_get_type())
G_DECLARE_FINAL_TYPE(PidginApplication, pidgin_application, PIDGIN,
APPLICATION, GtkApplication)
--- a/pidgin/pidginattachment.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/pidginattachment.h Tue Oct 19 02:49:28 2021 -0500
@@ -26,13 +26,6 @@
#ifndef PIDGIN_ATTACHMENT_H
#define PIDGIN_ATTACHMENT_H
- * SECTION:pidginattachment
- * @section_id: pidgin-pidginattachment
- * @short_description: <filename>pidginattachment.h</filename>
- * @title: Pidgin Attachment API
--- a/pidgin/pidginavatar.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/pidginavatar.h Tue Oct 19 02:49:28 2021 -0500
@@ -27,16 +27,6 @@
- * @section_id: pidgin-pidginavatar
- * @short_description: Avatars
- * @title: Avatar Widget
- * #PidginAvatar is a widget that displays avatars for contacts or
@@ -46,9 +36,12 @@
- * The standard _get_type macro for #PidginAvatar.
+ * #PidginAvatar is a widget that displays avatars for contacts or #define PIDGIN_TYPE_AVATAR (pidgin_avatar_get_type())
@@ -56,13 +49,6 @@
PIDGIN, AVATAR, GtkEventBox)
- * #PidginAvatar is an opaque data structure and should only be accessed via
* Creates a new #PidginAvatar instance.
--- a/pidgin/pidgincellrendererexpander.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/pidgincellrendererexpander.h Tue Oct 19 02:49:28 2021 -0500
@@ -27,17 +27,14 @@
#ifndef PIDGIN_CELL_RENDERER_EXPANDER_H
#define PIDGIN_CELL_RENDERER_EXPANDER_H
- * SECTION:pidgincellrendererexpander
- * @section_id: pidgin-cellrendererexpander
- * @short_description: <filename>pidgincellrendererexpander.h</filename>
- * @title: Cell Renderer Expander
+ * PidginCellRendererExpander: * A #GtkCellRenderer that can hide its children.
#define PIDGIN_TYPE_CELL_RENDERER_EXPANDER (pidgin_cell_renderer_expander_get_type())
G_DECLARE_FINAL_TYPE(PidginCellRendererExpander, pidgin_cell_renderer_expander,
PIDGIN, CELL_RENDERER_EXPANDER, GtkCellRenderer)
--- a/pidgin/pidginclosebutton.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/pidginclosebutton.h Tue Oct 19 02:49:28 2021 -0500
@@ -26,22 +26,21 @@
#ifndef PIDGIN_CLOSE_BUTTON_H
#define PIDGIN_CLOSE_BUTTON_H
- * SECTION:pidginclosebutton
- * @section_id: pidgin-close-button
- * @short_description: A widget to close things.
- * #PidginCloseButton is a transitional widget as we slowly migrate the
- * conversation window to glade.
+ * #PidginCloseButton is a transitional widget as we slowly migrate the + * conversation window to glade. #define PIDGIN_TYPE_CLOSE_BUTTON (pidgin_close_button_get_type())
G_DECLARE_FINAL_TYPE(PidginCloseButton, pidgin_close_button, PIDGIN,
--- a/pidgin/pidgincolor.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/pidgincolor.h Tue Oct 19 02:49:28 2021 -0500
@@ -24,15 +24,6 @@
# error "only <pidgin.h> may be included directly"
- * @section_id: pidgin-color
- * @short_description: Color related API
- * A collection of API to help with color.
--- a/pidgin/pidgincontactcompletion.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/pidgincontactcompletion.h Tue Oct 19 02:49:28 2021 -0500
@@ -26,11 +26,14 @@
#ifndef PIDGIN_CONTACT_COMPLETION_H
#define PIDGIN_CONTACT_COMPLETION_H
- * SECTION:pidgincontactcompletion
- * @section_id: pidgin-contact-completion
- * @short_description: A GtkEntryCompletion for contacts
- * @title: Contact Name Completion
+ * PidginContactCompletion: * #PidginContactCompletion should be treated like a normal
* #GtkEntryCompletion, except it already does all of the setup for the
@@ -46,12 +49,6 @@
#define PIDGIN_TYPE_CONTACT_COMPLETION pidgin_contact_completion_get_type()
G_DECLARE_FINAL_TYPE(PidginContactCompletion, pidgin_contact_completion, PIDGIN,
--- a/pidgin/pidgincontactlist.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/pidgincontactlist.h Tue Oct 19 02:49:28 2021 -0500
@@ -27,34 +27,18 @@
#ifndef PIDGIN_CONTACT_LIST_H
#define PIDGIN_CONTACT_LIST_H
- * SECTION:pidgincontactlist
- * @section_id: pidgin-contactlist
- * @short_description: The contact list widget.
- * @title: Contact list widget
- * #PidginContactList is a transitional widget as we slowly migrate it into the
- * conversation window to make a single window application.
- * PIDGIN_TYPE_CONTACT_LIST:
- * The standard _get_type method for #PidginContactList.
- * A #GtkWindow that contains the main contact list.
+ * #PidginContactList is a transitional widget as we slowly migrate it into the + * conversation window to make a single window application. --- a/pidgin/pidginconversationwindow.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/pidginconversationwindow.h Tue Oct 19 02:49:28 2021 -0500
@@ -27,21 +27,20 @@
#ifndef PIDGIN_CONVERSATION_WINDOW_H
#define PIDGIN_CONVERSATION_WINDOW_H
- * SECTION:pidginconversationwindow
- * @section_id: pidgin-pidginconversationwindow
- * @short_description: The main conversation window widget.
- * @title: Conversation window widget
- * #PidginConversationWindow is a widget that contains #PidginConversations.
+ * PidginConversationWindow: + * #PidginConversationWindow is a widget that contains #PidginConversations. #define PIDGIN_TYPE_CONVERSATION_WINDOW (pidgin_conversation_window_get_type())
G_DECLARE_FINAL_TYPE(PidginConversationWindow, pidgin_conversation_window,
PIDGIN, CONVERSATION_WINDOW, GtkApplicationWindow)
--- a/pidgin/pidgincore.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/pidgincore.h Tue Oct 19 02:49:28 2021 -0500
@@ -25,14 +25,6 @@
- * @section_id: pidgin-pidgincore
- * @short_description: <filename>pidgincore.h</filename>
- * @title: UI Definitions and Includes
- * The very core of Pidgin.
--- a/pidgin/pidgindebug.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/pidgindebug.h Tue Oct 19 02:49:28 2021 -0500
@@ -25,12 +25,6 @@
- * @section_id: pidgin-pidgindebug
- * @short_description: <filename>pidgindebug.h</filename>
--- a/pidgin/pidgindialog.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/pidgindialog.h Tue Oct 19 02:49:28 2021 -0500
@@ -26,22 +26,19 @@
- * @section_id: pidgin-dialog
- * @short_description: A base dialog widget.
- * #PidginDialog is a transitional widget as we slowly migrate everything to
+ * #PidginDialog is a transitional widget as we slowly migrate everything to #define PIDGIN_TYPE_DIALOG (pidgin_dialog_get_type())
G_DECLARE_FINAL_TYPE(PidginDialog, pidgin_dialog, PIDGIN,
--- a/pidgin/pidgingdkpixbuf.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/pidgingdkpixbuf.h Tue Oct 19 02:49:28 2021 -0500
@@ -31,13 +31,6 @@
- * SECTION:pidgingdkpixbuf
- * @section_id: pidgin-gdk-pixbuf
- * @short_description: <filename>pidgingdkpixbuf.h</filename>
- * @title: GDK Pixbuf Helpers
--- a/pidgin/pidginiconname.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/pidginiconname.h Tue Oct 19 02:49:28 2021 -0500
@@ -27,16 +27,6 @@
#ifndef PIDGIN_ICON_NAME_H
#define PIDGIN_ICON_NAME_H
- * SECTION:pidginiconname
- * @section_id: pidgin-pidginiconname
- * @title: Icon Name Utilities
- * @short_description: Get icon names for objects.
- * This API makes it easy to determine which icon should be used for different
--- a/pidgin/pidgininfopane.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/pidgininfopane.h Tue Oct 19 02:49:28 2021 -0500
@@ -27,16 +27,6 @@
#ifndef PIDGIN_INFO_PANE_H
#define PIDGIN_INFO_PANE_H
- * SECTION:pidgininfopane
- * @section_id: pidgin-pidgininfopane
- * @short_description: The information pane
- * @title: Information Pane Widget
- * #PidginInfoPane is a widget that displays information above
- * #PidginConversations.
@@ -45,6 +35,15 @@
+ * #PidginInfoPane is a widget that displays information above + * #PidginConversations. #define PIDGIN_TYPE_INFO_PANE (pidgin_info_pane_get_type())
G_DECLARE_FINAL_TYPE(PidginInfoPane, pidgin_info_pane, PIDGIN, INFO_PANE,
--- a/pidgin/pidgininvitedialog.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/pidgininvitedialog.h Tue Oct 19 02:49:28 2021 -0500
@@ -26,11 +26,14 @@
#ifndef PIDGIN_INVITE_DIALOG_H
#define PIDGIN_INVITE_DIALOG_H
- * SECTION:pidgininvitedialog
- * @section_id: pidgin-invite-dialog
- * @short_description: A dialog widget to invite others to chat
- * @title: Invite Dialog
* #PidginInviteDialog is a simple #GtkDialog that presents the user with an
* interface to invite another user to a conversation. Name completion is
@@ -60,14 +63,7 @@
#define PIDGIN_TYPE_INVITE_DIALOG pidgin_invite_dialog_get_type()
G_DECLARE_FINAL_TYPE(PidginInviteDialog, pidgin_invite_dialog, PIDGIN,
INVITE_DIALOG, GtkDialog)
--- a/pidgin/pidginmenutray.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/pidginmenutray.h Tue Oct 19 02:49:28 2021 -0500
@@ -24,13 +24,6 @@
#ifndef PIDGIN_MENU_TRAY_H
#define PIDGIN_MENU_TRAY_H
- * SECTION:pidginmenutray
- * @section_id: pidgin-menu-tray
- * @short_description: <filename>pidginmenutray.h</filename>
- * @title: Tray Menu Item
--- a/pidgin/pidginmessage.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/pidginmessage.h Tue Oct 19 02:49:28 2021 -0500
@@ -27,21 +27,20 @@
- * SECTION:pidginmessage
- * @section_id: pidgin-pidginmessage
- * @short_description: <filename>pidginmessage.h</filename>
- * @title: Pidgin Message API
- * #PidginMessage maps a #PurpleMessage to a #TalkatuMessage.
+ * #PidginMessage maps a #PurpleMessage to a #TalkatuMessage. #define PIDGIN_TYPE_MESSAGE (pidgin_message_get_type())
G_DECLARE_FINAL_TYPE(PidginMessage, pidgin_message, PIDGIN, MESSAGE, GObject)
--- a/pidgin/pidginmooddialog.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/pidginmooddialog.h Tue Oct 19 02:49:28 2021 -0500
@@ -27,15 +27,6 @@
#ifndef PIDGIN_MOOD_DIALOG_H
#define PIDGIN_MOOD_DIALOG_H
- * SECTION:pidginmooddialog
- * @section_id: pidgin-mood-dialog
- * @short_description: A dialog for selecting moods
- * A simple dialog for selecting a global mood as well as a per account mood.
--- a/pidgin/pidginplugininfo.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/pidginplugininfo.h Tue Oct 19 02:49:28 2021 -0500
@@ -34,6 +34,14 @@
+ * A #GPluginPluginInfo subclass that adds some Pidgin specific properties. #define PIDGIN_TYPE_PLUGIN_INFO (pidgin_plugin_info_get_type())
G_DECLARE_FINAL_TYPE(PidginPluginInfo, pidgin_plugin_info, PIDGIN, PLUGIN_INFO, PurplePluginInfo)
--- a/pidgin/pidginpluginsdialog.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/pidginpluginsdialog.h Tue Oct 19 02:49:28 2021 -0500
@@ -27,17 +27,16 @@
#ifndef PIDGIN_PLUGINS_DIALOG_H
#define PIDGIN_PLUGINS_DIALOG_H
- * SECTION:pidginpluginsdialog
- * @section_id: pidgin-plugins-dialog
- * @short_description: A widget to display available plugins
- * @title: Plugins Dialog
+ * A dialog that allows the user to configure their plugins. #define PIDGIN_TYPE_PLUGINS_DIALOG (pidgin_plugins_dialog_get_type())
G_DECLARE_FINAL_TYPE(PidginPluginsDialog, pidgin_plugins_dialog, PIDGIN,
PLUGINS_DIALOG, GtkDialog)
--- a/pidgin/pidginpluginsmenu.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/pidginpluginsmenu.h Tue Oct 19 02:49:28 2021 -0500
@@ -27,23 +27,22 @@
#ifndef PIDGIN_PLUGINS_MENU_H
#define PIDGIN_PLUGINS_MENU_H
- * SECTION:pidginpluginsmenu
- * @section_id: pidgin-plugins-menu
- * @short_description: A menu for managing plugins and their actions
* #PidginPluginsMenu is a #GtkMenu that provides an interface to users to open
* the plugin manager as well as activate plugin actions.
* It manages itself as plugins are loaded and unloaded and can be added as a
* submenu to any #GtkMenuItem.
#define PIDGIN_TYPE_PLUGINS_MENU (pidgin_plugins_menu_get_type())
G_DECLARE_FINAL_TYPE(PidginPluginsMenu, pidgin_plugins_menu, PIDGIN,
--- a/pidgin/pidginpresenceicon.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/pidginpresenceicon.h Tue Oct 19 02:49:28 2021 -0500
@@ -27,20 +27,19 @@
#ifndef PIDGIN_PRESENCE_ICON_H
#define PIDGIN_PRESENCE_ICON_H
- * SECTION:pidginpresenceicon
- * @section_id: pidgin-pidginpresenceicon
- * @short_description: Icons for presences
- * @title: Presence Icons
* A #GtkImage subclass that will automatically update when the given presence
#define PIDGIN_TYPE_PRESENCE_ICON (pidgin_presence_icon_get_type())
G_DECLARE_FINAL_TYPE(PidginPresenceIcon, pidgin_presence_icon,
PIDGIN, PRESENCE_ICON, GtkImage)
--- a/pidgin/pidginprotocolchooser.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/pidginprotocolchooser.h Tue Oct 19 02:49:28 2021 -0500
@@ -28,13 +28,6 @@
#ifndef PIDGIN_PROTOCOL_CHOOSER_H
#define PIDGIN_PROTOCOL_CHOOSER_H
- * SECTION:pidginprotocolchooser
- * @section_id: pidgin-protocol-chooser
- * @short_description: A #GtkComboBox for choosing protocols
- * @title: Pidgin Protocol Chooser Combo Box Widget
--- a/pidgin/pidginprotocolstore.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/pidginprotocolstore.h Tue Oct 19 02:49:28 2021 -0500
@@ -27,14 +27,13 @@
#define PIDGIN_PROTOCOL_STORE_H
- * SECTION:pidginprotocolstore
- * @section_id: pidgin-protocol-store
- * @short_description: A GtkListStore that keeps track of protocols
- * @title: Protocol Store
* #PidginProtocolStore is a #GtkListStore that automatically keeps track of
* what protocols are currently available in libpurple. It's intended to be
* used any time that you need to present a protocol selection to the user.
--- a/pidgin/pidginscrollbook.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/pidginscrollbook.h Tue Oct 19 02:49:28 2021 -0500
@@ -27,9 +27,7 @@
#ifndef PIDGIN_SCROLL_BOOK_H
#define PIDGIN_SCROLL_BOOK_H
- * SECTION:pidginscrollbook
- * @section_id: pidgin-pidginscrollbook
- * @title: Scrolling Notebook Widget
* This widget is used to show error messages in the buddy list window.
--- a/pidgin/pidginstock.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/pidginstock.h Tue Oct 19 02:49:28 2021 -0500
@@ -25,12 +25,6 @@
- * @section_id: pidgin-pidginstock
- * @short_description: <filename>pidginstock.h</filename>
- * @title: Stock Resources
#include "gtkstatus-icon-theme.h"
--- a/pidgin/pidginstylecontext.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/pidginstylecontext.h Tue Oct 19 02:49:28 2021 -0500
@@ -24,15 +24,6 @@
# error "only <pidgin.h> may be included directly"
- * SECTION:pidginstylecontext
- * @section_id: pidgin-pidginstylecontext
- * @short_description: Dark theme helpers.
- * @title: GtkStyleContext Helpers
- * A collection of API to help with handling dark themes.
#ifndef PIDGIN_STYLE_CONTEXT_H
#define PIDGIN_STYLE_CONTEXT_H
--- a/pidgin/pidgintalkatu.h Tue Oct 19 00:48:05 2021 -0500
+++ b/pidgin/pidgintalkatu.h Tue Oct 19 02:49:28 2021 -0500
@@ -26,13 +26,6 @@
- * SECTION:pidgintalkatu
- * @section_id: pidgin-talkatu
- * @short_description: <filename>pidgintalkatu.h</filename>
- * @title: Talkatu Helpers