Thu, 19 Dec 2019 14:25:49 +0100
Use gtk-doc comments (review pull request #632)
|
20147
66f05a854eee
applied changes from 8a731bbd0197fbcc91a705c2d8f528154216defa
Richard Laager <rlaager@pidgin.im>
parents:
19859
diff
changeset
|
1 | /* pidgin |
| 7432 | 2 | * |
| 15572 | 3 | * Pidgin is the legal property of its developers, whose names are too numerous |
| 8046 | 4 | * to list here. Please refer to the COPYRIGHT file distributed with this |
| 5 | * source distribution. | |
|
25888
d0fdd378a635
Remove trailing whitespace
Mark Doliner <markdoliner@pidgin.im>
parents:
21653
diff
changeset
|
6 | * |
| 7432 | 7 | * This program is free software; you can redistribute it and/or modify |
| 8 | * it under the terms of the GNU General Public License as published by | |
| 9 | * the Free Software Foundation; either version 2 of the License, or | |
| 10 | * (at your option) any later version. | |
| 11 | * | |
| 12 | * This program is distributed in the hope that it will be useful, | |
| 13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 15 | * GNU General Public License for more details. | |
| 16 | * | |
| 17 | * You should have received a copy of the GNU General Public License | |
| 18 | * along with this program; if not, write to the Free Software | |
|
19859
71d37b57eff2
The FSF changed its address a while ago; our files were out of date.
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
16254
diff
changeset
|
19 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA |
| 7432 | 20 | */ |
|
35487
494f09f7f331
Move section blocks inside inclusion guards -- otherwise g-ir-scanner yells
Ankit Vani <a@nevitus.org>
parents:
35486
diff
changeset
|
21 | |
|
39603
98fd85e156e0
Rename gtklog -> pidginlog.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
37133
diff
changeset
|
22 | #ifndef PIDGIN_LOG_H |
|
98fd85e156e0
Rename gtklog -> pidginlog.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
37133
diff
changeset
|
23 | #define PIDGIN_LOG_H |
|
35451
206524351826
Add sections for finch and re-arrange its doc index
Ankit Vani <a@nevitus.org>
parents:
35416
diff
changeset
|
24 | /** |
|
39603
98fd85e156e0
Rename gtklog -> pidginlog.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
37133
diff
changeset
|
25 | * SECTION:pidginlog |
|
98fd85e156e0
Rename gtklog -> pidginlog.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
37133
diff
changeset
|
26 | * @section_id: pidgin-log |
|
98fd85e156e0
Rename gtklog -> pidginlog.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
37133
diff
changeset
|
27 | * @short_description: <filename>pidginlog.h</filename> |
|
35451
206524351826
Add sections for finch and re-arrange its doc index
Ankit Vani <a@nevitus.org>
parents:
35416
diff
changeset
|
28 | * @title: Log Viewer |
|
39603
98fd85e156e0
Rename gtklog -> pidginlog.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
37133
diff
changeset
|
29 | * @see_also: <link linkend="chapter-signals-pidginlog">Log signals</link> |
|
35451
206524351826
Add sections for finch and re-arrange its doc index
Ankit Vani <a@nevitus.org>
parents:
35416
diff
changeset
|
30 | */ |
|
206524351826
Add sections for finch and re-arrange its doc index
Ankit Vani <a@nevitus.org>
parents:
35416
diff
changeset
|
31 | |
| 15577 | 32 | #include "pidgin.h" |
| 7432 | 33 | #include "log.h" |
| 34 | ||
| 35 | #include "account.h" | |
| 36 | ||
|
32790
b95c7c504118
Add G_BEGIN/END_DECLS to Pidgin public headers, most of which did
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
32438
diff
changeset
|
37 | G_BEGIN_DECLS |
|
21653
621c47778132
merge of '73ae9aeda3c58fbf8437421da68d19d06f93e686'
Evan Schoenberg <evands@pidgin.im>
parents:
21223
diff
changeset
|
38 | |
|
25889
26d9ca30335c
Change "screen name" to "username" or "buddy name" in a whole bunch of
Mark Doliner <markdoliner@pidgin.im>
parents:
25888
diff
changeset
|
39 | void pidgin_log_show(PurpleLogType type, const char *buddyname, PurpleAccount *account); |
|
20702
9548d4fb8c8e
Re-worked gtklog functions and perl bindings
Gabriel Schulhof <nix@go-nix.ca>
parents:
20684
diff
changeset
|
40 | void pidgin_log_show_contact(PurpleContact *contact); |
|
21215
775a49fdc926
Document the window transient_for changes. Refs #2617
Richard Laager <rlaager@pidgin.im>
parents:
21169
diff
changeset
|
41 | |
|
20702
9548d4fb8c8e
Re-worked gtklog functions and perl bindings
Gabriel Schulhof <nix@go-nix.ca>
parents:
20684
diff
changeset
|
42 | void pidgin_syslog_show(void); |
| 12674 | 43 | |
|
12838
5c6f36abeee8
[gaim-migrate @ 15186]
Richard Laager <rlaager@pidgin.im>
parents:
12674
diff
changeset
|
44 | /**************************************************************************/ |
|
39603
98fd85e156e0
Rename gtklog -> pidginlog.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
37133
diff
changeset
|
45 | /* Pidgin Log Subsystem */ |
|
12838
5c6f36abeee8
[gaim-migrate @ 15186]
Richard Laager <rlaager@pidgin.im>
parents:
12674
diff
changeset
|
46 | /**************************************************************************/ |
|
5c6f36abeee8
[gaim-migrate @ 15186]
Richard Laager <rlaager@pidgin.im>
parents:
12674
diff
changeset
|
47 | |
|
5c6f36abeee8
[gaim-migrate @ 15186]
Richard Laager <rlaager@pidgin.im>
parents:
12674
diff
changeset
|
48 | /** |
|
35416
35c615531b2a
Convert docs from doxygen to gtk-doc format for gtkdebug to gtksmiley
Ankit Vani <a@nevitus.org>
parents:
35393
diff
changeset
|
49 | * pidgin_log_init: |
|
35c615531b2a
Convert docs from doxygen to gtk-doc format for gtkdebug to gtksmiley
Ankit Vani <a@nevitus.org>
parents:
35393
diff
changeset
|
50 | * |
|
39603
98fd85e156e0
Rename gtklog -> pidginlog.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
37133
diff
changeset
|
51 | * Initializes the Pidgin log subsystem. |
|
12838
5c6f36abeee8
[gaim-migrate @ 15186]
Richard Laager <rlaager@pidgin.im>
parents:
12674
diff
changeset
|
52 | */ |
|
15562
8c8249fe5e3c
gaim_gtk to pidgin. I hope
Sean Egan <seanegan@pidgin.im>
parents:
15435
diff
changeset
|
53 | void pidgin_log_init(void); |
|
12838
5c6f36abeee8
[gaim-migrate @ 15186]
Richard Laager <rlaager@pidgin.im>
parents:
12674
diff
changeset
|
54 | |
|
5c6f36abeee8
[gaim-migrate @ 15186]
Richard Laager <rlaager@pidgin.im>
parents:
12674
diff
changeset
|
55 | /** |
|
35416
35c615531b2a
Convert docs from doxygen to gtk-doc format for gtkdebug to gtksmiley
Ankit Vani <a@nevitus.org>
parents:
35393
diff
changeset
|
56 | * pidgin_log_get_handle: |
|
35c615531b2a
Convert docs from doxygen to gtk-doc format for gtkdebug to gtksmiley
Ankit Vani <a@nevitus.org>
parents:
35393
diff
changeset
|
57 | * |
|
39603
98fd85e156e0
Rename gtklog -> pidginlog.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
37133
diff
changeset
|
58 | * Returns the Pidgin log subsystem handle. |
|
12838
5c6f36abeee8
[gaim-migrate @ 15186]
Richard Laager <rlaager@pidgin.im>
parents:
12674
diff
changeset
|
59 | * |
|
39603
98fd85e156e0
Rename gtklog -> pidginlog.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
37133
diff
changeset
|
60 | * Returns: The Pidgin log subsystem handle. |
|
12838
5c6f36abeee8
[gaim-migrate @ 15186]
Richard Laager <rlaager@pidgin.im>
parents:
12674
diff
changeset
|
61 | */ |
|
15562
8c8249fe5e3c
gaim_gtk to pidgin. I hope
Sean Egan <seanegan@pidgin.im>
parents:
15435
diff
changeset
|
62 | void *pidgin_log_get_handle(void); |
|
12838
5c6f36abeee8
[gaim-migrate @ 15186]
Richard Laager <rlaager@pidgin.im>
parents:
12674
diff
changeset
|
63 | |
|
5c6f36abeee8
[gaim-migrate @ 15186]
Richard Laager <rlaager@pidgin.im>
parents:
12674
diff
changeset
|
64 | /** |
|
35416
35c615531b2a
Convert docs from doxygen to gtk-doc format for gtkdebug to gtksmiley
Ankit Vani <a@nevitus.org>
parents:
35393
diff
changeset
|
65 | * pidgin_log_uninit: |
|
35c615531b2a
Convert docs from doxygen to gtk-doc format for gtkdebug to gtksmiley
Ankit Vani <a@nevitus.org>
parents:
35393
diff
changeset
|
66 | * |
|
39603
98fd85e156e0
Rename gtklog -> pidginlog.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
37133
diff
changeset
|
67 | * Uninitializes the Pidgin log subsystem. |
|
12838
5c6f36abeee8
[gaim-migrate @ 15186]
Richard Laager <rlaager@pidgin.im>
parents:
12674
diff
changeset
|
68 | */ |
|
15562
8c8249fe5e3c
gaim_gtk to pidgin. I hope
Sean Egan <seanegan@pidgin.im>
parents:
15435
diff
changeset
|
69 | void pidgin_log_uninit(void); |
|
12838
5c6f36abeee8
[gaim-migrate @ 15186]
Richard Laager <rlaager@pidgin.im>
parents:
12674
diff
changeset
|
70 | |
|
32790
b95c7c504118
Add G_BEGIN/END_DECLS to Pidgin public headers, most of which did
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
32438
diff
changeset
|
71 | G_END_DECLS |
|
b95c7c504118
Add G_BEGIN/END_DECLS to Pidgin public headers, most of which did
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
32438
diff
changeset
|
72 | |
|
39603
98fd85e156e0
Rename gtklog -> pidginlog.
Elliott Sales de Andrade <qulogic@pidgin.im>
parents:
37133
diff
changeset
|
73 | #endif /* PIDGIN_LOG_H */ |