doc/log-signals.dox

Mon, 17 Sep 2007 15:05:36 +0000

author
Will Thompson <resiak@pidgin.im>
date
Mon, 17 Sep 2007 15:05:36 +0000
branch
cpw.resiak.disconnectreason
changeset 20429
0e840b026c82
parent 16244
be35cbf49dfb
child 20897
2608e9e07913
permissions
-rw-r--r--

Remove non-error PurpleDisconnectReasons, and add PURPLE_REASON_OTHER_ERROR
for cases when the exact error is unknown or not in the enum.

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

mercurial