view doc/log-signals.dox @ 20497:89a82874d64e

merge of '85c73f22a9f7e979b53ff5d0d965a8cba49b35c0' and 'b72032dfc24c2067d0692d367120edaa068a1f7c'
author Ka-Hing Cheung <khc@hxbc.us>
date Sat, 08 Sep 2007 23:59:25 +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