Mercurial > pidgin.yaz
annotate doc/log-signals.dox @ 25945:751df82b78e7
propagate from branch 'im.pidgin.pidgin' (head 23720684a7671144bc56d1b20b6a1a0a22862d73)
to branch 'im.pidgin.cpw.darkrain42.xmpp.iq-handlers' (head 3bdb82c347184599c389f7ed65d02c61f2708b89)
| author | Paul Aurich <paul@darkrain42.org> |
|---|---|
| date | Tue, 10 Feb 2009 06:12:24 +0000 |
| parents | 0d8061bbfc1d |
| children |
| rev | line source |
|---|---|
| 12737 | 1 /** @page log-signals Log Signals |
| 2 | |
| 3 @signals | |
| 4 @signal log-timestamp | |
| 5 @endsignals | |
| 6 | |
|
20807
e0613cf8c493
Add some links from signal documentation back to the documentation for the
Will Thompson <will.thompson@collabora.co.uk>
parents:
16183
diff
changeset
|
7 @see log.h |
|
e0613cf8c493
Add some links from signal documentation back to the documentation for the
Will Thompson <will.thompson@collabora.co.uk>
parents:
16183
diff
changeset
|
8 |
| 12737 | 9 <hr> |
| 10 | |
| 11 @signaldef log-timestamp | |
| 12 @signalproto | |
|
21066
0d8061bbfc1d
Document the show_date parameters to the log-timestamp and
Etan Reisner <pidgin@unreliablesource.net>
parents:
20807
diff
changeset
|
13 char *(*log_timestamp)(PurpleLog *log, time_t when, gboolean show_date); |
| 12737 | 14 @endsignalproto |
| 15 @signaldesc | |
| 16 Emitted to allow plugins to customize the timestamp on a message | |
| 17 being logged. | |
|
21066
0d8061bbfc1d
Document the show_date parameters to the log-timestamp and
Etan Reisner <pidgin@unreliablesource.net>
parents:
20807
diff
changeset
|
18 @param log The log the message belongs to. |
|
0d8061bbfc1d
Document the show_date parameters to the log-timestamp and
Etan Reisner <pidgin@unreliablesource.net>
parents:
20807
diff
changeset
|
19 @param when The time to be converted to a string. |
|
0d8061bbfc1d
Document the show_date parameters to the log-timestamp and
Etan Reisner <pidgin@unreliablesource.net>
parents:
20807
diff
changeset
|
20 @param show_date Whether the date should be displayed. |
| 12737 | 21 @return A textual representation of the time, or @c NULL to use a |
| 22 default format. | |
|
16183
8cf53d7a0887
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents:
14617
diff
changeset
|
23 @note Plugins must be careful of logs with a type of PURPLE_LOG_SYSTEM. |
| 12737 | 24 @endsignaldef |
| 25 | |
| 26 */ | |
|
20807
e0613cf8c493
Add some links from signal documentation back to the documentation for the
Will Thompson <will.thompson@collabora.co.uk>
parents:
16183
diff
changeset
|
27 // vim: syntax=c.doxygen tw=75 et |