doc/log-signals.dox@931e39789506 (annotated)
doc/log-signals.dox
Thu, 28 Dec 2017 22:03:02 -0600
- author
- Gary Kramlich <grim@reaperworld.com>
- date
- Thu, 28 Dec 2017 22:03:02 -0600
- branch
- trac-17174
- changeset 38850
- 931e39789506
- parent 21142
- c2242c1fde7f
- permissions
- -rw-r--r--
closing merged branch
| 12737 | 1 | /** @page log-signals Log Signals |
| 2 | ||
| 3 | @signals | |
| 4 | @signal log-timestamp | |
| 5 | @endsignals | |
| 6 | ||
|
20897
2608e9e07913
Add some links from signal documentation back to the documentation for the
Will Thompson <resiak@pidgin.im>
parents:
16244
diff
changeset
|
7 | @see log.h |
|
2608e9e07913
Add some links from signal documentation back to the documentation for the
Will Thompson <resiak@pidgin.im>
parents:
16244
diff
changeset
|
8 | |
| 12737 | 9 | <hr> |
| 10 | ||
| 11 | @signaldef log-timestamp | |
| 12 | @signalproto | |
|
21142
c2242c1fde7f
Document the show_date parameters to the log-timestamp and
Etan Reisner <deryni@pidgin.im>
parents:
20897
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. | |
|
21142
c2242c1fde7f
Document the show_date parameters to the log-timestamp and
Etan Reisner <deryni@pidgin.im>
parents:
20897
diff
changeset
|
18 | @param log The log the message belongs to. |
|
c2242c1fde7f
Document the show_date parameters to the log-timestamp and
Etan Reisner <deryni@pidgin.im>
parents:
20897
diff
changeset
|
19 | @param when The time to be converted to a string. |
|
c2242c1fde7f
Document the show_date parameters to the log-timestamp and
Etan Reisner <deryni@pidgin.im>
parents:
20897
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. | |
|
16244
be35cbf49dfb
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents:
14679
diff
changeset
|
23 | @note Plugins must be careful of logs with a type of PURPLE_LOG_SYSTEM. |
| 12737 | 24 | @endsignaldef |
| 25 | ||
| 26 | */ | |
|
20897
2608e9e07913
Add some links from signal documentation back to the documentation for the
Will Thompson <resiak@pidgin.im>
parents:
16244
diff
changeset
|
27 | // vim: syntax=c.doxygen tw=75 et |
