view doc/log-signals.dox @ 17888:9a1c7a566d7c

explicit merge of '1c5a391126b5b506a29f0b9e34160d239cb783c6' and '8dee13b251ac588bb5ba3c9565e3badd0678254f'
author Jeffrey Connelly <jaconnel@calpoly.edu>
date Mon, 18 Jun 2007 01:48:35 +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