view doc/log-signals.dox @ 13492:59ea9ddd408b

[gaim-migrate @ 15868] Nathan fixed part of CID 24 by adding a missing return. This is a similar error in the next function in the file, also apparently tracked in CID 24. So, here's the same fix. Resolves CID 24 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