diff doc/log-signals.dox @ 12737:a1e241dd50b6

[gaim-migrate @ 15082] Conversation and Logging Message Timestamp Formatting... The idea here is that we should honor the user's locale for message timestamps in the conversation window and in the logs. I've added a signal and created a plugin that allows one to override this. The plugin is named "Message Timestamp Formats". Enabling that will by default change the timestamps back to the format we had before this commit. (That is to say, it forces the old format and ignores the locale.) The plugin also has options to show dates in the timestamps "Always", "In Chats", or "For Delayed Messages" (the default behavior). This addresses all requests for 12 hour timestamps, allows people to continue with the 24 hour timestamps we have, even if their locale says differently, enables plugin authors to override the message timestamp formats in any way they choose, and addresses requests for complete dates in logs. To recap, if you don't like the format string your locale has, enabled the "Message Timestamp Formats" plugin. committer: Tailor Script <[e-mail]>

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/log-signals.dox	Thu Jan 05 20:17:36 2006 +0000
@@ -0,0 +1,24 @@
+/** @page log-signals Log Signals
+
+ @signals
+  @signal log-timestamp
+ @endsignals
+
+ <hr>
+
+ @signaldef log-timestamp
+  @signalproto
+char *(*log_timestamp)(GaimConversation *conv, struct tm *tm);
+  @endsignalproto
+  @signaldesc
+   Emitted to allow plugins to customize the timestamp on a message
+   being logged.
+  @param log The log the message belongs to.
+  @param tm 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 GAIM_LOG_SYSTEM.
+ @endsignaldef
+
+*/
+// vim: syntax=c tw=75 et