Mercurial > pidgin
changeset 21066:0d8061bbfc1d
Document the show_date parameters to the log-timestamp and
conversation-timestamp signals.
| author | Etan Reisner <pidgin@unreliablesource.net> |
|---|---|
| date | Wed, 17 Oct 2007 04:10:34 +0000 |
| parents | ff00e91f962e |
| children | 96929e7acb86 |
| files | doc/gtkconv-signals.dox doc/log-signals.dox |
| diffstat | 2 files changed, 9 insertions(+), 6 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/gtkconv-signals.dox Wed Oct 17 04:05:19 2007 +0000 +++ b/doc/gtkconv-signals.dox Wed Oct 17 04:10:34 2007 +0000 @@ -28,12 +28,14 @@ @signaldef conversation-timestamp @signalproto -char *(*conversation_timestamp)(PurpleConversation *conv, time_t when); +char *(*conversation_timestamp)(PurpleConversation *conv, time_t when, + gboolean show_date); @endsignalproto @signaldesc Emitted to allow plugins to customize the timestamp on a message. - @param conv The conversation the message belongs to. - @param when The time to be converted to a string. + @param conv The conversation 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. @endsignaldef
--- a/doc/log-signals.dox Wed Oct 17 04:05:19 2007 +0000 +++ b/doc/log-signals.dox Wed Oct 17 04:10:34 2007 +0000 @@ -10,13 +10,14 @@ @signaldef log-timestamp @signalproto -char *(*log_timestamp)(PurpleLog *log, time_t when); +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 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.