view doc/log-signals.dox @ 20230:72d7a692b1ac

applied changes from be5b7db12bee643aba7b97fdacfb036dc384ea1f through 35f0eb88d9f2d034e575f7e17f6c02605b3a76e2
author Richard Laager <rlaager@wiktel.com>
date Fri, 28 Sep 2007 15:51:44 +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