view doc/log-signals.dox @ 16257:b20fa7ebb911

Ari sent in a patch, saying: "If you've run configure outside of the main source tree (e.g. in a build/ subdirectory) in the latest mtn tree, doxygen (make docs) won't work because it can't find the header/footer. This patch should fix the issue." Closes #200

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