view doc/log-signals.dox @ 21219:5f829728a1a5

propagate from branch 'im.pidgin.sadrul.currentmedia' (head 734d4a6e0655850d5f891d22d4c37f15d0ccf1bd) to branch 'next.minor' (head c52c996c95bec84928db81dc592640366ff5a432)
author Sadrul Habib Chowdhury <imadil@gmail.com>
date Fri, 12 Oct 2007 02:06:38 +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