doc/reference/libpurple/signals_core.xml

Mon, 21 Oct 2013 17:54:13 +0530

author
Ankit Vani <a@nevitus.org>
date
Mon, 21 Oct 2013 17:54:13 +0530
branch
soc.2013.gobjectification.plugins
changeset 36912
68bb6c155722
parent 36905
d256e7a2ec4c
child 36915
13cf9f35c2aa
permissions
-rw-r--r--

Refactored signals_plugin.xml to properly use gtk-doc style. These changes are to be used as template for other signal docs.

<?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-core">
  <title>Core signals</title>

  <programlisting>
 @signals
  @signal quitting
  @signal uri-handler
 @endsignals

 @see core.h

 @signaldef quitting
  @signalproto
void (*quitting)();
  @endsignalproto
  @signaldesc
   Emitted when libpurple is quitting.
 @endsignaldef

 @signaldef uri-handler
  @signalproto
gboolean (*uri_handler)(const gchar *proto, const gchar *cmd, GHashTable *params);
  @endsignalproto
  @signaldesc
   Emitted when handling a registered URI.
  @param proto The protocol of the URI.
  @param cmd The 'command' of the URI.
  @param params Any key/value parameters from the URI.
 @endsignaldef

  </programlisting>
</chapter>

mercurial