doc/connection-signals.dox

Sun, 07 Oct 2007 18:49:50 +0000

author
Will Thompson <resiak@pidgin.im>
date
Sun, 07 Oct 2007 18:49:50 +0000
changeset 20897
2608e9e07913
parent 16244
be35cbf49dfb
child 21286
759b1949f5ce
permissions
-rw-r--r--

Add some links from signal documentation back to the documentation for the
corresponding header. Also, if there are going to be vim modelines with
"syntax" settings, they may as well be "c.doxygen" not "c".

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
20897
2608e9e07913 Add some links from signal documentation back to the documentation for the
Will Thompson <resiak@pidgin.im>
parents: 16244
diff changeset
10 @see connection.h
2608e9e07913 Add some links from signal documentation back to the documentation for the
Will Thompson <resiak@pidgin.im>
parents: 16244
diff changeset
11
6611
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
12 <hr>
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
13
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
14 @signaldef signing-on
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
15 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 6724
diff changeset
16 void (*signing_on)(PurpleConnection *gc);
6611
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
17 @endsignalproto
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
18 @signaldesc
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
19 Emitted when a connection is about to sign on.
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
20 @param gc The connection that is about to sign on.
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
21 @endsignaldef
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
22
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
23 @signaldef signed-on
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
24 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 6724
diff changeset
25 void (*signed_on)(PurpleConnection *gc);
6611
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
26 @endsignalproto
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
27 @signaldesc
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
28 Emitted when a connection has signed on.
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
29 @param gc The connection that has signed on.
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
30 @endsignaldef
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
31
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
32 @signaldef signing-off
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
33 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 6724
diff changeset
34 void (*signing_off)(PurpleConnection *gc);
6611
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
35 @endsignalproto
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
36 @signaldesc
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
37 Emitted when a connection is about to sign off.
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
38 @param gc The connection that is about to sign off.
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
39 @endsignaldef
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
40
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
41 @signaldef signed-off
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
42 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 6724
diff changeset
43 void (*signed_off)(PurpleConnection *gc);
6611
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
44 @endsignalproto
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
45 @signaldesc
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
46 Emitted when a connection has signed off.
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
47 @param gc The connection that has signed off.
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
48 @endsignaldef
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
49
f41aa03e0fba [gaim-migrate @ 7135]
Christian Hammond <chipx86@chipx86.com>
parents:
diff changeset
50 */
20897
2608e9e07913 Add some links from signal documentation back to the documentation for the
Will Thompson <resiak@pidgin.im>
parents: 16244
diff changeset
51 // vim: syntax=c.doxygen tw=75 et

mercurial