Mercurial > pidgin.yaz
view doc/connection-signals.dox @ 23842:7ff461621d77
Correct documentation about list account options to reflect what the key and
value of the PurpleKeyValuePair actually represent (based on what Pidgin does
with them). (Since the only protocol to use them, silc, uses the same string
for the key and the value, no harm came of me having written incorrect
documentation last time.)
author | Will Thompson <will.thompson@collabora.co.uk> |
---|---|
date | Sun, 17 Aug 2008 11:10:39 +0000 |
parents | 95a7d1a72fd9 |
children | 73c8e1964eef |
line wrap: on
line source
/** @page connection-signals Connection Signals @signals @signal signing-on @signal signed-on @signal signing-off @signal signed-off @signal connection-error @endsignals @see connection.h <hr> @signaldef signing-on @signalproto void (*signing_on)(PurpleConnection *gc); @endsignalproto @signaldesc Emitted when a connection is about to sign on. @param gc The connection that is about to sign on. @endsignaldef @signaldef signed-on @signalproto void (*signed_on)(PurpleConnection *gc); @endsignalproto @signaldesc Emitted when a connection has signed on. @param gc The connection that has signed on. @endsignaldef @signaldef signing-off @signalproto void (*signing_off)(PurpleConnection *gc); @endsignalproto @signaldesc Emitted when a connection is about to sign off. @param gc The connection that is about to sign off. @endsignaldef @signaldef signed-off @signalproto void (*signed_off)(PurpleConnection *gc); @endsignalproto @signaldesc Emitted when a connection has signed off. @param gc The connection that has signed off. @endsignaldef @signaldef connection-error @signalproto void (*connection_error)(PurpleConnection *gc, PurpleConnectionError err, const gchar *desc) @endsignalproto @signaldesc Emitted when a connection error occurs, before @ref signed-off. @param gc The connection on which the error has occured @param err The error that occured @param desc A description of the error, giving more information. @endsignaldef */ // vim: syntax=c.doxygen tw=75 et