doc/reference/libpurple/log-signals.dox

branch
soc.2013.gobjectification.plugins
changeset 36900
423fbe5e5289
parent 21142
c2242c1fde7f
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/reference/libpurple/log-signals.dox	Sun Oct 13 15:41:22 2013 +0530
@@ -0,0 +1,27 @@
+/** @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, gboolean show_date);
+  @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.
+  @param show_date Whether the date should be displayed.
+  @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