doc/log-signals.dox

Tue, 23 Oct 2007 17:41:06 +0000

author
Richard Laager <rlaager@pidgin.im>
date
Tue, 23 Oct 2007 17:41:06 +0000
changeset 21079
1445ee9aa7bc
parent 20897
2608e9e07913
child 21142
c2242c1fde7f
permissions
-rw-r--r--

propagate from branch 'im.pidgin.pidgin.2.2.2' (head 346b13a7c448a4526e5fdbd279df981177d8fc3a)
to branch 'im.pidgin.pidgin' (head cfa72c6f2a1ddd1dbbcccd02259a75b762cf70a2)

/** @page log-signals Log Signals

 @signals
  @signal log-timestamp
 @endsignals

 @see log.h

 <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.doxygen tw=75 et

mercurial