diff options
author | Gary Kramlich <grim@reaperworld.com> | 2021-08-04 04:40:54 -0500 |
---|---|---|
committer | Gary Kramlich <grim@reaperworld.com> | 2021-08-04 04:40:54 -0500 |
commit | e7a275df761f9449359b52d2919f4c38312de510 (patch) | |
tree | cf4ef502dd4b2e246d20e57d35e5390d40b332f4 /doc | |
parent | 61bc1a87178b18781a5c41259e7b1b83696aef9e (diff) | |
download | pidgin-e7a275df761f9449359b52d2919f4c38312de510.tar.gz |
A bunch of random libpurple documentation fixes
Testing Done:
Build the docs and verified the fixes in `build/doc/reference/libpurple/libpurple-undocumented.txt`
Reviewed at https://reviews.imfreedom.org/r/872/
Diffstat (limited to 'doc')
-rw-r--r-- | doc/reference/libpurple/libpurple-docs.xml | 39 | ||||
-rw-r--r-- | doc/reference/libpurple/meson.build | 1 | ||||
-rw-r--r-- | doc/reference/libpurple/signals_protocol.xml | 63 |
3 files changed, 24 insertions, 79 deletions
diff --git a/doc/reference/libpurple/libpurple-docs.xml b/doc/reference/libpurple/libpurple-docs.xml index 62ae1f79ec..42372da404 100644 --- a/doc/reference/libpurple/libpurple-docs.xml +++ b/doc/reference/libpurple/libpurple-docs.xml @@ -60,8 +60,6 @@ <xi:include href="xml/plugins.xml" /> <xi:include href="xml/prefs.xml" /> <xi:include href="xml/pluginpref.xml" /> - <xi:include href="xml/protocol.xml" /> - <xi:include href="xml/protocols.xml" /> <xi:include href="xml/proxy.xml" /> <xi:include href="xml/purple-gio.xml" /> <xi:include href="xml/purpleaccountoption.xml" /> @@ -74,25 +72,13 @@ <xi:include href="xml/purpleconversation.xml" /> <xi:include href="xml/purpleconversationmanager.xml" /> <xi:include href="xml/purpleconversationuiops.xml" /> - <xi:include href="xml/purplecredentialmanager.xml" /> - <xi:include href="xml/purplecredentialprovider.xml" /> <xi:include href="xml/purpledebugui.xml" /> <xi:include href="xml/purpleimconversation.xml" /> <xi:include href="xml/purplekeyvaluepair.xml" /> <xi:include href="xml/purplemarkup.xml" /> - <xi:include href="xml/purplenoopcredentialprovider.xml" /> <xi:include href="xml/purpleoptions.xml" /> <xi:include href="xml/purpleplugininfo.xml" /> <xi:include href="xml/purplepresence.xml" /> - <xi:include href="xml/purpleprotocolattention.xml" /> - <xi:include href="xml/purpleprotocolchat.xml" /> - <xi:include href="xml/purpleprotocolclient.xml" /> - <xi:include href="xml/purpleprotocolfactory.xml" /> - <xi:include href="xml/purpleprotocolim.xml" /> - <xi:include href="xml/purpleprotocolmanager.xml" /> - <xi:include href="xml/purpleprotocolmedia.xml" /> - <xi:include href="xml/purpleprotocolprivacy.xml" /> - <xi:include href="xml/purpleprotocolserver.xml" /> <xi:include href="xml/purplewhiteboard.xml" /> <xi:include href="xml/purplewhiteboardops.xml" /> <xi:include href="xml/purplewhiteboarduiops.xml" /> @@ -117,6 +103,30 @@ <xi:include href="xml/util.xml" /> </part> + <part id="Credentials"> + <title>Credentials</title> + + <xi:include href="xml/purplecredentialmanager.xml" /> + <xi:include href="xml/purplecredentialprovider.xml" /> + <xi:include href="xml/purplenoopcredentialprovider.xml" /> + </part> + + <part id="Protocols"> + <title>Protocols</title> + + <xi:include href="xml/protocol.xml" /> + <xi:include href="xml/protocols.xml" /> + <xi:include href="xml/purpleprotocolattention.xml" /> + <xi:include href="xml/purpleprotocolchat.xml" /> + <xi:include href="xml/purpleprotocolclient.xml" /> + <xi:include href="xml/purpleprotocolfactory.xml" /> + <xi:include href="xml/purpleprotocolim.xml" /> + <xi:include href="xml/purpleprotocolmanager.xml" /> + <xi:include href="xml/purpleprotocolmedia.xml" /> + <xi:include href="xml/purpleprotocolprivacy.xml" /> + <xi:include href="xml/purpleprotocolserver.xml" /> + </part> + <part id="Submodules"> <title>Submodules</title> <chapter id="messages"> @@ -172,7 +182,6 @@ <xi:include href="signals_log.xml" /> <xi:include href="signals_notify.xml" /> <xi:include href="signals_plugin.xml" /> - <xi:include href="signals_protocol.xml" /> <xi:include href="signals_savedstatus.xml" /> <xi:include href="signals_jabber.xml" /> </part> diff --git a/doc/reference/libpurple/meson.build b/doc/reference/libpurple/meson.build index 6a7cb21da3..cc7e8ca927 100644 --- a/doc/reference/libpurple/meson.build +++ b/doc/reference/libpurple/meson.build @@ -53,7 +53,6 @@ content_files = [ 'signals_log.xml', 'signals_notify.xml', 'signals_plugin.xml', - 'signals_protocol.xml', 'signals_savedstatus.xml', 'signals_xfer.xml', 'tut_c_plugins.xml', diff --git a/doc/reference/libpurple/signals_protocol.xml b/doc/reference/libpurple/signals_protocol.xml deleted file mode 100644 index 813ef2bf20..0000000000 --- a/doc/reference/libpurple/signals_protocol.xml +++ /dev/null @@ -1,63 +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-protocol"> -<title>Protocol signals</title> - -<refsect1 id="protocols.signals" role="signal_proto"> -<title role="signal_proto.title">List of signals</title> -<synopsis> - "<link linkend="protocols-protocol-added">protocol-added</link>" - "<link linkend="protocols-protocol-removed">protocol-removed</link>" -</synopsis> -</refsect1> - -<refsect1 id="protocols.signal-details" role="signals"> -<title role="signals.title">Signal details</title> - -<refsect2 id="protocols-protocol-added" role="signal"> - <title>The <literal>"protocol-added"</literal> signal</title> -<programlisting> -void user_function (PurpleProtocol *protocol, - gpointer user_data) -</programlisting> - <para> -Emitted when a protocol is added. - </para> - <variablelist role="params"> - <varlistentry> - <term><parameter>protocol</parameter> :</term> - <listitem><simpara>The protocol that was added.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter>user_data</parameter> :</term> - <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem> - </varlistentry> - </variablelist> -</refsect2> - -<refsect2 id="protocols-protocol-removed" role="signal"> - <title>The <literal>"protocol-removed"</literal> signal</title> -<programlisting> -void user_function (PurpleProtocol *protocol, - gpointer user_data) -</programlisting> - <para> -Emitted when a protocol is removed. - </para> - <variablelist role="params"> - <varlistentry> - <term><parameter>protocol</parameter> :</term> - <listitem><simpara>The protocol that was removed.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter>user_data</parameter> :</term> - <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem> - </varlistentry> - </variablelist> -</refsect2> - -</refsect1> - -</chapter> |