view doc/log-signals.dox @ 20378:9aa7b93ede27

propagate from branch 'im.pidgin.pidgin.2.2.1' (head 4df875eebff2a8d563baebf86297bd4bf0dc240a) to branch 'im.pidgin.rlaager.merging.2_2_1_conflicts' (head 193dd268b0be5ca0a4a8fa0e4188452907114be0)
author Richard Laager <rlaager@wiktel.com>
date Fri, 28 Sep 2007 19:45:05 +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