changeset 27912:4179ab2cfe1f

Document the uri-handler signal. Did I get this right?
author Etan Reisner <pidgin@unreliablesource.net>
date Fri, 14 Aug 2009 00:32:23 +0000
parents 5ab7766a6c83
children 25ad8f6b2638
files doc/core-signals.dox
diffstat 1 files changed, 12 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/doc/core-signals.dox	Thu Aug 13 23:34:25 2009 +0000
+++ b/doc/core-signals.dox	Fri Aug 14 00:32:23 2009 +0000
@@ -2,6 +2,7 @@
 
  @signals
   @signal quitting
+  @signal uri-handler
  @endsignals
 
  @see core.h
@@ -16,5 +17,16 @@
    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
+
  */
 // vim: syntax=c.doxygen tw=75 et