doc/log-signals.dox

Sun, 28 Oct 2007 16:32:37 +0000

author
Will Thompson <resiak@pidgin.im>
date
Sun, 28 Oct 2007 16:32:37 +0000
branch
cpw.resiak.disconnectreason
changeset 21295
46659b1bf31f
parent 20897
2608e9e07913
child 21142
c2242c1fde7f
permissions
-rw-r--r--

PurpleConnectionErrorPair is a better name for struct { PurpleConnectionError;
const char *desc } than PurpleAccountCurrentError.

12737
e1300804318e [gaim-migrate @ 15082]
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
1 /** @page log-signals Log Signals
e1300804318e [gaim-migrate @ 15082]
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
2
e1300804318e [gaim-migrate @ 15082]
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
3 @signals
e1300804318e [gaim-migrate @ 15082]
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
4 @signal log-timestamp
e1300804318e [gaim-migrate @ 15082]
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
5 @endsignals
e1300804318e [gaim-migrate @ 15082]
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
6
20897
2608e9e07913 Add some links from signal documentation back to the documentation for the
Will Thompson <resiak@pidgin.im>
parents: 16244
diff changeset
7 @see log.h
2608e9e07913 Add some links from signal documentation back to the documentation for the
Will Thompson <resiak@pidgin.im>
parents: 16244
diff changeset
8
12737
e1300804318e [gaim-migrate @ 15082]
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
9 <hr>
e1300804318e [gaim-migrate @ 15082]
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
10
e1300804318e [gaim-migrate @ 15082]
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
11 @signaldef log-timestamp
e1300804318e [gaim-migrate @ 15082]
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
12 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 14679
diff changeset
13 char *(*log_timestamp)(PurpleLog *log, time_t when);
12737
e1300804318e [gaim-migrate @ 15082]
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
14 @endsignalproto
e1300804318e [gaim-migrate @ 15082]
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
15 @signaldesc
e1300804318e [gaim-migrate @ 15082]
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
16 Emitted to allow plugins to customize the timestamp on a message
e1300804318e [gaim-migrate @ 15082]
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
17 being logged.
e1300804318e [gaim-migrate @ 15082]
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
18 @param log The log the message belongs to.
14049
c15c41423e19 [gaim-migrate @ 16559]
Richard Laager <rlaager@pidgin.im>
parents: 12737
diff changeset
19 @param when The time to be converted to a string.
12737
e1300804318e [gaim-migrate @ 15082]
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
20 @return A textual representation of the time, or @c NULL to use a
e1300804318e [gaim-migrate @ 15082]
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
21 default format.
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 14679
diff changeset
22 @note Plugins must be careful of logs with a type of PURPLE_LOG_SYSTEM.
12737
e1300804318e [gaim-migrate @ 15082]
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
23 @endsignaldef
e1300804318e [gaim-migrate @ 15082]
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
24
e1300804318e [gaim-migrate @ 15082]
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
25 */
20897
2608e9e07913 Add some links from signal documentation back to the documentation for the
Will Thompson <resiak@pidgin.im>
parents: 16244
diff changeset
26 // vim: syntax=c.doxygen tw=75 et

mercurial