annotate doc/connection-signals.dox @ 28570:0d9f5172ebc9

No need to call this twice.
author Elliott Sales de Andrade <qulogic@pidgin.im>
date Fri, 04 Sep 2009 21:44:58 +0000
parents 73c8e1964eef
children 378cceb9131d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6724
aca39e77db85 [gaim-migrate @ 7251]
Christian Hammond <chipx86@chipx86.com>
parents: 6611
diff changeset
1 /** @page connection-signals Connection Signals
6611
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
2
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
3 @signals
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
4 @signal signing-on
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
5 @signal signed-on
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
6 @signal signing-off
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
7 @signal signed-off
23588
95a7d1a72fd9 A2B in #pidgin noticed that the link was missing
Ka-Hing Cheung <khc@hxbc.us>
parents: 21365
diff changeset
8 @signal connection-error
6611
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
9 @endsignals
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
10
20807
e0613cf8c493 Add some links from signal documentation back to the documentation for the
Will Thompson <will.thompson@collabora.co.uk>
parents: 16183
diff changeset
11 @see connection.h
e0613cf8c493 Add some links from signal documentation back to the documentation for the
Will Thompson <will.thompson@collabora.co.uk>
parents: 16183
diff changeset
12
6611
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
13 <hr>
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
14
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
15 @signaldef signing-on
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
16 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 6724
diff changeset
17 void (*signing_on)(PurpleConnection *gc);
6611
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
18 @endsignalproto
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
19 @signaldesc
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
20 Emitted when a connection is about to sign on.
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
21 @param gc The connection that is about to sign on.
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
22 @endsignaldef
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
23
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
24 @signaldef signed-on
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
25 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 6724
diff changeset
26 void (*signed_on)(PurpleConnection *gc);
6611
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
27 @endsignalproto
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
28 @signaldesc
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
29 Emitted when a connection has signed on.
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
30 @param gc The connection that has signed on.
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
31 @endsignaldef
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
32
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
33 @signaldef signing-off
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
34 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 6724
diff changeset
35 void (*signing_off)(PurpleConnection *gc);
6611
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
36 @endsignalproto
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
37 @signaldesc
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
38 Emitted when a connection is about to sign off.
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
39 @param gc The connection that is about to sign off.
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
40 @endsignaldef
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
41
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
42 @signaldef signed-off
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
43 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 6724
diff changeset
44 void (*signed_off)(PurpleConnection *gc);
6611
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
45 @endsignalproto
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
46 @signaldesc
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
47 Emitted when a connection has signed off.
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
48 @param gc The connection that has signed off.
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
49 @endsignaldef
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
50
21365
3a269007711e Document connection-error signal.
Will Thompson <will.thompson@collabora.co.uk>
parents: 20807
diff changeset
51 @signaldef connection-error
3a269007711e Document connection-error signal.
Will Thompson <will.thompson@collabora.co.uk>
parents: 20807
diff changeset
52 @signalproto
3a269007711e Document connection-error signal.
Will Thompson <will.thompson@collabora.co.uk>
parents: 20807
diff changeset
53 void (*connection_error)(PurpleConnection *gc, PurpleConnectionError err, const gchar *desc)
3a269007711e Document connection-error signal.
Will Thompson <will.thompson@collabora.co.uk>
parents: 20807
diff changeset
54 @endsignalproto
3a269007711e Document connection-error signal.
Will Thompson <will.thompson@collabora.co.uk>
parents: 20807
diff changeset
55 @signaldesc
3a269007711e Document connection-error signal.
Will Thompson <will.thompson@collabora.co.uk>
parents: 20807
diff changeset
56 Emitted when a connection error occurs, before @ref signed-off.
27366
73c8e1964eef A semi-random collection of English spelling and grammatical changes.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 23588
diff changeset
57 @param gc The connection on which the error has occurred
73c8e1964eef A semi-random collection of English spelling and grammatical changes.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents: 23588
diff changeset
58 @param err The error that occurred
21365
3a269007711e Document connection-error signal.
Will Thompson <will.thompson@collabora.co.uk>
parents: 20807
diff changeset
59 @param desc A description of the error, giving more information.
3a269007711e Document connection-error signal.
Will Thompson <will.thompson@collabora.co.uk>
parents: 20807
diff changeset
60 @endsignaldef
3a269007711e Document connection-error signal.
Will Thompson <will.thompson@collabora.co.uk>
parents: 20807
diff changeset
61
6611
6e3bec3c843e [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
62 */
20807
e0613cf8c493 Add some links from signal documentation back to the documentation for the
Will Thompson <will.thompson@collabora.co.uk>
parents: 16183
diff changeset
63 // vim: syntax=c.doxygen tw=75 et