annotate doc/log-signals.dox @ 17148:9a649a04fd74

When the /pidgin/debug/enabled pref is toggled, wait until the next iteration through the event loop before drawing or hiding the window. This fixes the bug where we lost the width and height prefs for the debug window because of the following sequence of event 1. Init gtkdebug window, set default width and height 2. Read in pref for /pidgin/debug/enabled and show debug window using default width and height 3. Read in pref for /pidgin/debug/width and height, but it's too late! The window has already been drawn using the default width and height! This is a pretty minor thing, but it was bugging me. I don't like having to always make the debug window bigger when I start Pidgin. The downside of this change is that we won't see as much debug output in the window when starting Pidgin.

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