doc/log-signals.dox@2608e9e07913 (annotated)
doc/log-signals.dox
Sun, 07 Oct 2007 18:49:50 +0000
- author
- Will Thompson <resiak@pidgin.im>
- date
- Sun, 07 Oct 2007 18:49:50 +0000
- changeset 20897
- 2608e9e07913
- parent 16244
- be35cbf49dfb
- child 21142
- c2242c1fde7f
- permissions
- -rw-r--r--
Add some links from signal documentation back to the documentation for the
corresponding header. Also, if there are going to be vim modelines with
"syntax" settings, they may as well be "c.doxygen" not "c".
| 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 | |
|
16244
be35cbf49dfb
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents:
14679
diff
changeset
|
13 | char *(*log_timestamp)(PurpleLog *log, time_t when); |
| 12737 | 14 | @endsignalproto |
| 15 | @signaldesc | |
| 16 | Emitted to allow plugins to customize the timestamp on a message | |
| 17 | being logged. | |
| 18 | @param log The log the message belongs to. | |
|
14049
c15c41423e19
[gaim-migrate @ 16559]
Richard Laager <rlaager@pidgin.im>
parents:
12737
diff
changeset
|
19 | @param when The time to be converted to a string. |
| 12737 | 20 | @return A textual representation of the time, or @c NULL to use a |
| 21 | default format. | |
|
16244
be35cbf49dfb
Update the Doxygen signals documentation to match the new struct names.
Richard Laager <rlaager@pidgin.im>
parents:
14679
diff
changeset
|
22 | @note Plugins must be careful of logs with a type of PURPLE_LOG_SYSTEM. |
| 12737 | 23 | @endsignaldef |
| 24 | ||
| 25 | */ | |
|
20897
2608e9e07913
Add some links from signal documentation back to the documentation for the
Will Thompson <resiak@pidgin.im>
parents:
16244
diff
changeset
|
26 | // vim: syntax=c.doxygen tw=75 et |
