annotate doc/log-signals.dox @ 12752:91424393b70b

[gaim-migrate @ 15099] This should work around a bug where receiving a null byte over irc would basicly make gaim ignore all further input on that irc connection, eventually resulting in a ping timeout. Since you can't see null bytes, This was actually pretty weird and confusing. Of course, IRC should never send a client a null byte. But we're doing some odd things with irc at work, so... committer: Tailor Script <[e-mail]>

/** @page log-signals Log Signals

 @signals
  @signal log-timestamp
 @endsignals

 <hr>

 @signaldef log-timestamp
  @signalproto
char *(*log_timestamp)(GaimConversation *conv, struct tm *tm);
  @endsignalproto
  @signaldesc
   Emitted to allow plugins to customize the timestamp on a message
   being logged.
  @param log The log the message belongs to.
  @param tm 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