view doc/log-signals.dox @ 30789:0d5dab71be7a

propagate from branch 'im.pidgin.pidgin' (head 637cbec3044756a8ef4273f687d84b18f10b05c4) to branch 'im.pidgin.soc.2010.icq-tlc' (head 12dd3c1a3cb110106f7ef72077145596ea358642)

/** @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