view doc/log-signals.dox @ 21750:fb8ab2490ac4

De-magic number the prpl_info->keepalive interval, and document it.
author Will Thompson <will.thompson@collabora.co.uk>
date Mon, 03 Dec 2007 19:02:28 +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