view doc/log-signals.dox @ 19346:0762e505818c

propagate from branch 'im.pidgin.pidgin' (head f2e4f8c57473f011b24033fff466bbf6aec3d32b) to branch 'im.pidgin.soc.2007.msimprpl' (head 3bc9019be48309b7a3febf99c858463a47b631ef)
author Jeffrey Connelly <jaconnel@calpoly.edu>
date Tue, 21 Aug 2007 02:36:35 +0000
parents 8cf53d7a0887
children e0613cf8c493
line wrap: on
line source

/** @page log-signals Log Signals

 @signals
  @signal log-timestamp
 @endsignals

 <hr>

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

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