view doc/log-signals.dox @ 20475:2a2cc0b57d8f

propagate from branch 'im.pidgin.pidgin' (head 5e94d4a46251e35e2b640180905fe364b82355e5) to branch 'im.pidgin.cpw.khc.msnp14' (head 7e42b1cb607bb785ef1a7d9e724f7d3ad0189f08)
author Ka-Hing Cheung <khc@hxbc.us>
date Sun, 22 Jul 2007 18:17:41 +0000
parents 8cf53d7a0887
children e0613cf8c493
line wrap: on
line source

/** @page log-signals Log Signals

 @signals
  @signal log-timestamp
 @endsignals

 <hr>

 @signaldef log-timestamp
  @signalproto
char *(*log_timestamp)(PurpleLog *log, time_t when);
  @endsignalproto
  @signaldesc
   Emitted to allow plugins to customize the timestamp on a message
   being logged.
  @param log The log the message belongs to.
  @param when The time to be converted to a string.
  @return A textual representation of the time, or @c NULL to use a
          default format.
  @note Plugins must be careful of logs with a type of PURPLE_LOG_SYSTEM.
 @endsignaldef

*/
// vim: syntax=c tw=75 et