doc/log-signals.dox

Sat, 05 May 2007 18:11:32 +0000

author
Ethan Blanton <elb@pidgin.im>
date
Sat, 05 May 2007 18:11:32 +0000
changeset 16955
0c96c19627d2
parent 16244
be35cbf49dfb
child 20897
2608e9e07913
permissions
-rw-r--r--

heh

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
e1300804318e [gaim-migrate @ 15082]
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
7 <hr>
e1300804318e [gaim-migrate @ 15082]
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
8
e1300804318e [gaim-migrate @ 15082]
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
9 @signaldef log-timestamp
e1300804318e [gaim-migrate @ 15082]
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
10 @signalproto
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 14679
diff changeset
11 char *(*log_timestamp)(PurpleLog *log, time_t when);
12737
e1300804318e [gaim-migrate @ 15082]
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
12 @endsignalproto
e1300804318e [gaim-migrate @ 15082]
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
13 @signaldesc
e1300804318e [gaim-migrate @ 15082]
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
14 Emitted to allow plugins to customize the timestamp on a message
e1300804318e [gaim-migrate @ 15082]
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
15 being logged.
e1300804318e [gaim-migrate @ 15082]
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
16 @param log The log the message belongs to.
14049
c15c41423e19 [gaim-migrate @ 16559]
Richard Laager <rlaager@pidgin.im>
parents: 12737
diff changeset
17 @param when The time to be converted to a string.
12737
e1300804318e [gaim-migrate @ 15082]
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
18 @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
19 default format.
16244
be35cbf49dfb Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents: 14679
diff changeset
20 @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
21 @endsignaldef
e1300804318e [gaim-migrate @ 15082]
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
22
e1300804318e [gaim-migrate @ 15082]
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
23 */
e1300804318e [gaim-migrate @ 15082]
Richard Laager <rlaager@pidgin.im>
parents:
diff changeset
24 // vim: syntax=c tw=75 et

mercurial