view doc/log-signals.dox @ 15039:9a69964d8c18

[gaim-migrate @ 17822] found this while setting up a unit testing framework (we're already reaping the benefits) committer: Tailor Script <tailor@pidgin.im>
author Nathan Walp <nwalp@pidgin.im>
date Sun, 26 Nov 2006 20:45:29 +0000
parents 3df4aadebc20
children 8cf53d7a0887
line wrap: on
line source

/** @page log-signals Log Signals

 @signals
  @signal log-timestamp
 @endsignals

 <hr>

 @signaldef log-timestamp
  @signalproto
char *(*log_timestamp)(GaimLog *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 GAIM_LOG_SYSTEM.
 @endsignaldef

*/
// vim: syntax=c tw=75 et