view doc/log-signals.dox @ 27969:32ef0358b469

propagate from branch 'im.pidgin.pidgin' (head 7c0f8ebeda0f59bd50e8e1692886616f302badcf) to branch 'im.pidgin.cpw.darkrain42.2.6.1' (head 7313bb3a50bfb81413f4fb007c26df5836a97397)
author Paul Aurich <paul@darkrain42.org>
date Wed, 22 Jul 2009 04:15:09 +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