annotate doc/log-signals.dox @ 17086:4fd7ec01b3f3

Adding Intel Corporation to cover all our bases here: (19:25:17) rlaager: arjan: How should I list you in COPYRIGHT? (19:26:08) arjan: if you want to add me: Arjan van de Ven <arjan@linux.intel.com> (19:26:21) arjan: but it's such a small change that I don't think I deserve that privilege ;) (19:26:47) rlaager: arjan: We add people for even a single character change. ;) By which word does your last name alphabetize? (19:27:01) arjan: eh. if you're in .nl, by "Ven" (19:27:08) arjan: but.. in english usually by "van" (19:27:53) rlaager: arjan: Is any of this work copyright Intel? (19:28:09) arjan: rlaager: I think Intel considers it too small to be copyrigthable (19:29:05) arjan: rlaager: but otherwise if you think it is then yes it's all Intel
author Richard Laager <rlaager@wiktel.com>
date Tue, 15 May 2007 00:30:22 +0000
parents 8cf53d7a0887
children e0613cf8c493
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
12737
a1e241dd50b6 [gaim-migrate @ 15082]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
1 /** @page log-signals Log Signals
a1e241dd50b6 [gaim-migrate @ 15082]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
2
a1e241dd50b6 [gaim-migrate @ 15082]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
3 @signals
a1e241dd50b6 [gaim-migrate @ 15082]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
4 @signal log-timestamp
a1e241dd50b6 [gaim-migrate @ 15082]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
5 @endsignals
a1e241dd50b6 [gaim-migrate @ 15082]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
6
a1e241dd50b6 [gaim-migrate @ 15082]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
7 <hr>
a1e241dd50b6 [gaim-migrate @ 15082]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
8
a1e241dd50b6 [gaim-migrate @ 15082]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
9 @signaldef log-timestamp
a1e241dd50b6 [gaim-migrate @ 15082]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
10 @signalproto
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 14617
diff changeset
11 char *(*log_timestamp)(PurpleLog *log, time_t when);
12737
a1e241dd50b6 [gaim-migrate @ 15082]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
12 @endsignalproto
a1e241dd50b6 [gaim-migrate @ 15082]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
13 @signaldesc
a1e241dd50b6 [gaim-migrate @ 15082]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
14 Emitted to allow plugins to customize the timestamp on a message
a1e241dd50b6 [gaim-migrate @ 15082]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
15 being logged.
a1e241dd50b6 [gaim-migrate @ 15082]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
16 @param log The log the message belongs to.
13987
f94309c7c480 [gaim-migrate @ 16559]
Richard Laager <rlaager@wiktel.com>
parents: 12737
diff changeset
17 @param when The time to be converted to a string.
12737
a1e241dd50b6 [gaim-migrate @ 15082]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
18 @return A textual representation of the time, or @c NULL to use a
a1e241dd50b6 [gaim-migrate @ 15082]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
19 default format.
16183
8cf53d7a0887 Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@wiktel.com>
parents: 14617
diff changeset
20 @note Plugins must be careful of logs with a type of PURPLE_LOG_SYSTEM.
12737
a1e241dd50b6 [gaim-migrate @ 15082]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
21 @endsignaldef
a1e241dd50b6 [gaim-migrate @ 15082]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
22
a1e241dd50b6 [gaim-migrate @ 15082]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
23 */
a1e241dd50b6 [gaim-migrate @ 15082]
Richard Laager <rlaager@wiktel.com>
parents:
diff changeset
24 // vim: syntax=c tw=75 et