view doc/log-signals.dox @ 20521:3cdf78c6c850

propagate from branch 'im.pidgin.pidgin' (head 5a3c2bb6d5725a73e614aa69d0e5beb04aba2d19) to branch 'im.pidgin.cpw.khc.msnp14' (head 62acf636b8dff8ae149e05aa9409e13951218ab5)

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