Fix the docs that were broken when the sound api was removed

Fri, 14 Aug 2020 01:18:11 -0500

author
Gary Kramlich <grim@reaperworld.com>
date
Fri, 14 Aug 2020 01:18:11 -0500
changeset 40510
09975c2082c5
parent 40509
6748a5ec6644
child 40511
ec08ac1f7d5f

Fix the docs that were broken when the sound api was removed

Update the docs for the sound api removal

Testing Done:
Built libpurple-doc, finch-doc, pidgin-doc, and facebook-doc, verified no errors.

Reviewed at https://reviews.imfreedom.org/r/68/

doc/reference/finch/finch-docs.xml file | annotate | diff | comparison | revisions
doc/reference/libpurple/libpurple-docs.xml file | annotate | diff | comparison | revisions
doc/reference/libpurple/meson.build file | annotate | diff | comparison | revisions
doc/reference/libpurple/signals_sound.xml file | annotate | diff | comparison | revisions
doc/reference/pidgin/pidgin-docs.xml file | annotate | diff | comparison | revisions
--- a/doc/reference/finch/finch-docs.xml	Thu Aug 13 22:03:41 2020 -0500
+++ b/doc/reference/finch/finch-docs.xml	Fri Aug 14 01:18:11 2020 -0500
@@ -39,7 +39,6 @@
       <xi:include href="xml/gntprefs.xml" />
       <xi:include href="xml/gntrequest.xml" />
       <xi:include href="xml/gntroomlist.xml" />
-      <xi:include href="xml/gntsound.xml" />
       <xi:include href="xml/gntstatus.xml" />
       <xi:include href="xml/gntui.xml" />
       <xi:include href="xml/finch.xml" />
--- a/doc/reference/libpurple/libpurple-docs.xml	Thu Aug 13 22:03:41 2020 -0500
+++ b/doc/reference/libpurple/libpurple-docs.xml	Fri Aug 14 01:18:11 2020 -0500
@@ -77,7 +77,6 @@
       <xi:include href="xml/roomlist.xml" />
       <xi:include href="xml/savedstatuses.xml" />
       <xi:include href="xml/server.xml" />
-      <xi:include href="xml/sound.xml" />
       <xi:include href="xml/core.xml" />
       <xi:include href="xml/status.xml" />
       <xi:include href="xml/stun.xml" />
@@ -86,8 +85,6 @@
       <xi:include href="xml/theme-loader.xml" />
       <xi:include href="xml/theme-manager.xml" />
       <xi:include href="xml/trie.xml" />
-      <xi:include href="xml/sound-theme.xml" />
-      <xi:include href="xml/sound-theme-loader.xml" />
       <xi:include href="xml/upnp.xml" />
       <xi:include href="xml/xmlnode.xml" />
       <xi:include href="xml/version.xml" />
@@ -152,7 +149,6 @@
       <xi:include href="signals_plugin.xml" />
       <xi:include href="signals_protocol.xml" />
       <xi:include href="signals_savedstatus.xml" />
-      <xi:include href="signals_sound.xml" />
       <xi:include href="signals_jabber.xml" />
   </part>
 
--- a/doc/reference/libpurple/meson.build	Thu Aug 13 22:03:41 2020 -0500
+++ b/doc/reference/libpurple/meson.build	Fri Aug 14 01:18:11 2020 -0500
@@ -46,7 +46,6 @@
     'signals_plugin.xml',
     'signals_protocol.xml',
     'signals_savedstatus.xml',
-    'signals_sound.xml',
     'signals_xfer.xml',
     'tut_c_plugins.xml',
     'tut_signals.xml',
--- a/doc/reference/libpurple/signals_sound.xml	Thu Aug 13 22:03:41 2020 -0500
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,50 +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-sound">
-<title>Sound signals</title>
-
-<refsect1 id="sound.signals" role="signal_proto">
-<title role="signal_proto.title">List of signals</title>
-<synopsis>
-  &quot;<link linkend="sound-playing-sound-event">playing-sound-event</link>&quot;
-</synopsis>
-</refsect1>
-
-<refsect1 id="sound.signal-details" role="signals">
-<title role="signals.title">Signal details</title>
-
-<refsect2 id="sound-playing-sound-event" role="signal">
- <title>The <literal>&quot;playing-sound-event&quot;</literal> signal</title>
-<programlisting>
-gboolean            user_function                      (PurpleSoundEventID event,
-                                                        PurpleAccount *account,
-                                                        gpointer user_data)
-</programlisting>
-  <para>
-Emitted when libpurple is going to play a sound event. This can be used to cancel playing sound by returning TRUE.
-  </para>
-  <variablelist role="params">
-  <varlistentry>
-    <term><parameter>event</parameter>&#160;:</term>
-    <listitem><simpara>The event this sound represents.</simpara></listitem>
-  </varlistentry>
-  <varlistentry>
-    <term><parameter>account</parameter>&#160;:</term>
-    <listitem><simpara>The account the sound is being played for.</simpara></listitem>
-  </varlistentry>
-  <varlistentry>
-    <term><parameter>user_data</parameter>&#160;:</term>
-    <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
-  </varlistentry>
-  <varlistentry>
-    <term><emphasis>Returns</emphasis>&#160;:</term>
-    <listitem><simpara><literal>TRUE</literal> if the sound should not be played, or <literal>FALSE</literal> otherwise.</simpara></listitem>
-  </varlistentry>
-  </variablelist>
-</refsect2>
-
-</refsect1>
-
-</chapter>
--- a/doc/reference/pidgin/pidgin-docs.xml	Thu Aug 13 22:03:41 2020 -0500
+++ b/doc/reference/pidgin/pidgin-docs.xml	Fri Aug 14 01:18:11 2020 -0500
@@ -45,7 +45,6 @@
       <xi:include href="xml/gtkscrollbook.xml" />
       <xi:include href="xml/gtksmiley-manager.xml" />
       <xi:include href="xml/gtksmiley-theme.xml" />
-      <xi:include href="xml/gtksound.xml" />
       <xi:include href="xml/gtkstatus-icon-theme.xml" />
       <xi:include href="xml/gtkstatusbox.xml" />
       <xi:include href="xml/gtkstyle.xml" />

mercurial