view doc/log-signals.dox @ 17367:837b697723c0

merge of '4af1e220d3ae855eec7a057ef1e41b586abb8f5f' and 'c5effd605c706950531cbca778c43fafa75e1109'
author Sean Egan <seanegan@gmail.com>
date Tue, 29 May 2007 04:56:30 +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