view doc/log-signals.dox @ 30539:4d8569be274c

merge of '392709af0c706d582bbd6a2b1f0d9423457e6351' and 'b1c7aabc888f764a6ed12bd30699c654534ea253'
author Marcus Lundblad <ml@update.uu.se>
date Mon, 06 Sep 2010 19:41:27 +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