view doc/log-signals.dox @ 20919:f48bee915ede

merge of '111659964eabcb60dd83e3598df42b5d4b788a90' and '5e03fe2d3a1f4d81543aeffc399cf6d05210e16b'
author Richard Laager <rlaager@wiktel.com>
date Sat, 13 Oct 2007 21:23:54 +0000
parents e0613cf8c493
children 0d8061bbfc1d
line wrap: on
line source

/** @page log-signals Log Signals

 @signals
  @signal log-timestamp
 @endsignals

 @see log.h

 <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.doxygen tw=75 et