doc/connection-signals.dox

Mon, 17 Sep 2007 15:05:36 +0000

author
Will Thompson <resiak@pidgin.im>
date
Mon, 17 Sep 2007 15:05:36 +0000
branch
cpw.resiak.disconnectreason
changeset 20429
0e840b026c82
parent 16244
be35cbf49dfb
child 20897
2608e9e07913
permissions
-rw-r--r--

Remove non-error PurpleDisconnectReasons, and add PURPLE_REASON_OTHER_ERROR
for cases when the exact error is unknown or not in the enum.

6724
e1d416a4a4bc [gaim-migrate @ 7251]
Christian Hammond <chipx86@chipx86.com>
parents: 6611
diff changeset
1 /** @page connection-signals Connection Signals
6611
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
2
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
3 @signals
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
4 @signal signing-on
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
5 @signal signed-on
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
6 @signal signing-off
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
7 @signal signed-off
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
8 @endsignals
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
9
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
10 <hr>
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
11
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
12 @signaldef signing-on
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
13 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 6724
diff changeset
14 void (*signing_on)(PurpleConnection *gc);
6611
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
15 @endsignalproto
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
16 @signaldesc
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
17 Emitted when a connection is about to sign on.
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
18 @param gc The connection that is about to sign on.
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
19 @endsignaldef
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
20
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
21 @signaldef signed-on
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
22 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 6724
diff changeset
23 void (*signed_on)(PurpleConnection *gc);
6611
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
24 @endsignalproto
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
25 @signaldesc
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
26 Emitted when a connection has signed on.
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
27 @param gc The connection that has signed on.
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
28 @endsignaldef
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
29
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
30 @signaldef signing-off
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
31 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 6724
diff changeset
32 void (*signing_off)(PurpleConnection *gc);
6611
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
33 @endsignalproto
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
34 @signaldesc
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
35 Emitted when a connection is about to sign off.
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
36 @param gc The connection that is about to sign off.
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
37 @endsignaldef
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
38
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
39 @signaldef signed-off
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
40 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 6724
diff changeset
41 void (*signed_off)(PurpleConnection *gc);
6611
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
42 @endsignalproto
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
43 @signaldesc
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
44 Emitted when a connection has signed off.
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
45 @param gc The connection that has signed off.
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
46 @endsignaldef
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
47
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
48 */
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
49 // vim: syntax=c tw=75 et

mercurial