annotate doc/certificate-signals.dox @ 20818:c560286daede

Clarify the documentation of the return value of purple_connection_reason_is_fatal, and explain why purple_connection_error checks wants_to_die.
author Will Thompson <will.thompson@collabora.co.uk>
date Wed, 10 Oct 2007 15:16:20 +0000
parents c0ccfe389b23
children e0613cf8c493
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19045
2aa5a9f47470 - Add CertificatePool signals documentation
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
1 /** @page certificate-signals Certificate Signals
2aa5a9f47470 - Add CertificatePool signals documentation
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
2
2aa5a9f47470 - Add CertificatePool signals documentation
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
3 @signals
2aa5a9f47470 - Add CertificatePool signals documentation
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
4 @signal certificate-stored
2aa5a9f47470 - Add CertificatePool signals documentation
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
5 @signal certificate-deleted
2aa5a9f47470 - Add CertificatePool signals documentation
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
6 @endsignals
2aa5a9f47470 - Add CertificatePool signals documentation
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
7
2aa5a9f47470 - Add CertificatePool signals documentation
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
8 <hr>
2aa5a9f47470 - Add CertificatePool signals documentation
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
9
2aa5a9f47470 - Add CertificatePool signals documentation
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
10 @signaldef certificate-stored
2aa5a9f47470 - Add CertificatePool signals documentation
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
11 @signalproto
2aa5a9f47470 - Add CertificatePool signals documentation
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
12 void (*certificate_stored)(PurpleCertificatePool *pool, const gchar *id, gpointer data);
2aa5a9f47470 - Add CertificatePool signals documentation
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
13 @endsignalproto
2aa5a9f47470 - Add CertificatePool signals documentation
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
14 @signaldesc
19051
c0ccfe389b23 - Add notice that certificate-stored and certificate-deleted signals are
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19045
diff changeset
15 Emitted when a pool stores a certificate. Connect to the pool instance.
19045
2aa5a9f47470 - Add CertificatePool signals documentation
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
16 @param pool Pool the certificate has been stored into
2aa5a9f47470 - Add CertificatePool signals documentation
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
17 @param id Key the certificate was stored under
2aa5a9f47470 - Add CertificatePool signals documentation
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
18 @endsignaldef
2aa5a9f47470 - Add CertificatePool signals documentation
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
19
2aa5a9f47470 - Add CertificatePool signals documentation
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
20 @signaldef certificate-deleted
2aa5a9f47470 - Add CertificatePool signals documentation
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
21 @signalproto
2aa5a9f47470 - Add CertificatePool signals documentation
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
22 void (*certificate_deleted)(PurpleCertificatePool *pool, const gchar *id, gpointer data);
2aa5a9f47470 - Add CertificatePool signals documentation
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
23 @endsignalproto
2aa5a9f47470 - Add CertificatePool signals documentation
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
24 @signaldesc
19051
c0ccfe389b23 - Add notice that certificate-stored and certificate-deleted signals are
William Ehlhardt <williamehlhardt@gmail.com>
parents: 19045
diff changeset
25 Emitted when a pool deletes a certificate. Connect to the pool instance.
19045
2aa5a9f47470 - Add CertificatePool signals documentation
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
26 @param pool Pool the certificate was deleted from
2aa5a9f47470 - Add CertificatePool signals documentation
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
27 @param id Key that was deleted
2aa5a9f47470 - Add CertificatePool signals documentation
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
28 @endsignaldef
2aa5a9f47470 - Add CertificatePool signals documentation
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
29
2aa5a9f47470 - Add CertificatePool signals documentation
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
30 */
2aa5a9f47470 - Add CertificatePool signals documentation
William Ehlhardt <williamehlhardt@gmail.com>
parents:
diff changeset
31 // vim: syntax=c tw=75 et