doc/log-signals.dox

Wed, 11 Jan 2006 22:52:48 +0000

author
Richard Laager <rlaager@pidgin.im>
date
Wed, 11 Jan 2006 22:52:48 +0000
changeset 12832
e5eb305a240d
parent 12737
e1300804318e
child 14049
c15c41423e19
permissions
-rw-r--r--

[gaim-migrate @ 15180]
I noticed this comment didn't line up. Yeah, this is a lame commit, but I'm forcing a recompile anyway, by changing a dependency of this header file.

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

mercurial