view doc/log-signals.dox @ 29129:ebb424b7e0a1

merge of '0bd5c5d235ae8c70b289e3b55a19523c4e28539e' and '9ba62902a7be15503ccd0006cd59c73fecc6255c'
author Mark Doliner <mark@kingant.net>
date Thu, 03 Dec 2009 08:02:54 +0000
parents 0d8061bbfc1d
children
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, gboolean show_date);
  @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.
  @param show_date Whether the date should be displayed.
  @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