annotate doc/log-signals.dox @ 20958:2002a6a32b0c

Using i686-apple-darwin9-gcc-4.0.1 (GCC) 4.0.1 (Apple Inc. build 5465) for compilation, I can't compile account.c because of the 'bool' component of PurpleAccountSetting - it's apparently treating it as a type. Changing it to 'boolean' is more consistent with the naming of the other parts of the union, in any case. The error given is: --- account.c:55: error: two or more data types in declaration specifiers account.c:55: warning: declaration does not declare anything account.c: In function 'setting_to_xmlnode': account.c:107: error: syntax error before '_Bool' ----

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