Mercurial > pidgin.yaz
view doc/connection-signals.dox @ 23308:67581872c47f
Documentation: Use the word opaque to describe the data structure
returned from purple_proxy_connect(). Might be a little more clear
to some people.
author | Mark Doliner <mark@kingant.net> |
---|---|
date | Sat, 07 Jun 2008 01:06:41 +0000 |
parents | 3a269007711e |
children | 95a7d1a72fd9 |
line wrap: on
line source
/** @page connection-signals Connection Signals @signals @signal signing-on @signal signed-on @signal signing-off @signal signed-off @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