doc/cipher-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
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".

12053
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents:
diff changeset
1 /** @page cipher-signals Cipher Signals
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents:
diff changeset
2
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents:
diff changeset
3 @signals
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents:
diff changeset
4 @signal cipher-added
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents:
diff changeset
5 @signal cipher-removed
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents:
diff changeset
6 @endsignals
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents:
diff changeset
7
20897
2608e9e07913 Add some links from signal documentation back to the documentation for the
Will Thompson <resiak@pidgin.im>
parents: 16244
diff changeset
8 @see cipher.h
2608e9e07913 Add some links from signal documentation back to the documentation for the
Will Thompson <resiak@pidgin.im>
parents: 16244
diff changeset
9
12053
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents:
diff changeset
10 <hr>
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents:
diff changeset
11
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents:
diff changeset
12 @signaldef cipher-added
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents:
diff changeset
13 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 12053
diff changeset
14 void (*cipher_added)(PurpleCipher *cipher);
12053
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents:
diff changeset
15 @endsignalproto
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents:
diff changeset
16 @signaldesc
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents:
diff changeset
17 Emitted when a cipher is added.
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents:
diff changeset
18 @param cipher The cipher that was added.
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents:
diff changeset
19 @endsignaldef
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents:
diff changeset
20
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents:
diff changeset
21 @signaldef cipher-removed
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents:
diff changeset
22 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 12053
diff changeset
23 void (*cipher_removed)(PurpleCipher *cipher);
12053
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents:
diff changeset
24 @endsignalproto
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents:
diff changeset
25 @signaldesc
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents:
diff changeset
26 Emitted when a cipher is removed.
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents:
diff changeset
27 @param cipher The cipher that was removed.
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents:
diff changeset
28 @endsignaldef
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents:
diff changeset
29
5aa634db0fc1 [gaim-migrate @ 14348]
Casey Harkins <charkins@pidgin.im>
parents:
diff changeset
30 */
20897
2608e9e07913 Add some links from signal documentation back to the documentation for the
Will Thompson <resiak@pidgin.im>
parents: 16244
diff changeset
31 // vim: syntax=c.doxygen tw=75 et

mercurial