Mercurial > pidgin3 / file revision

doc/reference/libpurple/signals_plugin.xml@7a4e48594a24

doc/reference/libpurple/signals_plugin.xml

Mon, 18 Jan 2021 23:07:50 -0600

author
Gary Kramlich <grim@reaperworld.com>
date
Mon, 18 Jan 2021 23:07:50 -0600
changeset 40716
7a4e48594a24
parent 37097
aef5930bd889
permissions
-rw-r--r--

Update all of the development documentation

Add documentation for using our repos and how to contribute to them.

Testing Done:
Built the docs locally and verified they look decent.

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

<?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-plugin">
<title>Plugin signals</title>

<refsect1 id="plugins.signals" role="signal_proto">
<title role="signal_proto.title">List of signals</title>
<synopsis>
  &quot;<link linkend="plugins-plugin-load">plugin-load</link>&quot;
  &quot;<link linkend="plugins-plugin-unload">plugin-unload</link>&quot;
</synopsis>
</refsect1>

<refsect1 id="plugins.signal-details" role="signals">
<title role="signals.title">Signal details</title>

<refsect2 id="plugins-plugin-load" role="signal">
 <title>The <literal>&quot;plugin-load&quot;</literal> signal</title>
<programlisting>
void                user_function                      (PurplePlugin *plugin,
                                                        gpointer user_data)
</programlisting>
  <para>
Emitted when a plugin is loaded.
  </para>
  <variablelist role="params">
  <varlistentry>
    <term><parameter>plugin</parameter>&#160;:</term>
    <listitem><simpara>The plugin that was loaded.</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>
  </variablelist>
</refsect2>

<refsect2 id="plugins-plugin-unload" role="signal">
 <title>The <literal>&quot;plugin-unload&quot;</literal> signal</title>
<programlisting>
void                user_function                      (PurplePlugin *plugin,
                                                        gpointer user_data)
</programlisting>
  <para>
Emitted when a plugin is unloaded.
  </para>
  <variablelist role="params">
  <varlistentry>
    <term><parameter>plugin</parameter>&#160;:</term>
    <listitem><simpara>The plugin that was unloaded.</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>
  </variablelist>
</refsect2>

</refsect1>

</chapter>

Mercurial Repository: pidgin3

mercurial