view doc/log-signals.dox @ 29079:e0c20f0e04bc

propagate from branch 'im.pidgin.pidgin' (head 09828caa4a3333f2f0eed91315c29d5b3aa66fcb) to branch 'im.pidgin.pidgin.next.minor' (head ccf1c70ee84a00016887a8c9f790556a4c6fb6d5)
author John Bailey <rekkanoryo@rekkanoryo.org>
date Sat, 22 Aug 2009 03:59:35 +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