view doc/log-signals.dox @ 23969:4ecea8ae3d21

merge of '3c1dec61837db8f0f51fc35f7ca26ff948a4e4f4' and 'd03f77d92751b3104fa7f211c86084c46a8679b7'
author Elliott Sales de Andrade <qulogic@pidgin.im>
date Tue, 26 Aug 2008 04:08:22 +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