view doc/log-signals.dox @ 17909:f7bf776d628a

propagate from branch 'im.pidgin.pidgin' (head 82644c8641c5089ed2cafd58983010f0144b7699) to branch 'im.pidgin.soc.2007.certmgr' (head 2a3b163efb32d6c8631c49f0da7f368e21e194a4)
author William Ehlhardt <williamehlhardt@gmail.com>
date Fri, 01 Jun 2007 23:53:05 +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