finch/gntidle.h

Thu, 19 Dec 2019 14:25:49 +0100

author
Fabrice Bellet <fabrice@bellet.info>
date
Thu, 19 Dec 2019 14:25:49 +0100
branch
port-changes-from-branch-2.x.y-to-default
changeset 40273
a8cee989c2ab
parent 39887
9c8f874c74a0
child 40359
ca141ea93b83
permissions
-rw-r--r--

Use gtk-doc comments (review pull request #632)

39887
9c8f874c74a0 Clean up all of the license headers
Gary Kramlich <grim@reaperworld.com>
parents: 39885
diff changeset
1 /*
9c8f874c74a0 Clean up all of the license headers
Gary Kramlich <grim@reaperworld.com>
parents: 39885
diff changeset
2 * finch
15802
1e124a68997e gntgaim idle reporting, this fixes idle return
Richard Nelson <wabz@pidgin.im>
parents:
diff changeset
3 *
1e124a68997e gntgaim idle reporting, this fixes idle return
Richard Nelson <wabz@pidgin.im>
parents:
diff changeset
4 * Pidgin is the legal property of its developers, whose names are too numerous
1e124a68997e gntgaim idle reporting, this fixes idle return
Richard Nelson <wabz@pidgin.im>
parents:
diff changeset
5 * to list here. Please refer to the COPYRIGHT file distributed with this
1e124a68997e gntgaim idle reporting, this fixes idle return
Richard Nelson <wabz@pidgin.im>
parents:
diff changeset
6 * source distribution.
1e124a68997e gntgaim idle reporting, this fixes idle return
Richard Nelson <wabz@pidgin.im>
parents:
diff changeset
7 *
1e124a68997e gntgaim idle reporting, this fixes idle return
Richard Nelson <wabz@pidgin.im>
parents:
diff changeset
8 * This program is free software; you can redistribute it and/or modify
1e124a68997e gntgaim idle reporting, this fixes idle return
Richard Nelson <wabz@pidgin.im>
parents:
diff changeset
9 * it under the terms of the GNU General Public License as published by
1e124a68997e gntgaim idle reporting, this fixes idle return
Richard Nelson <wabz@pidgin.im>
parents:
diff changeset
10 * the Free Software Foundation; either version 2 of the License, or
1e124a68997e gntgaim idle reporting, this fixes idle return
Richard Nelson <wabz@pidgin.im>
parents:
diff changeset
11 * (at your option) any later version.
1e124a68997e gntgaim idle reporting, this fixes idle return
Richard Nelson <wabz@pidgin.im>
parents:
diff changeset
12 *
1e124a68997e gntgaim idle reporting, this fixes idle return
Richard Nelson <wabz@pidgin.im>
parents:
diff changeset
13 * This program is distributed in the hope that it will be useful,
1e124a68997e gntgaim idle reporting, this fixes idle return
Richard Nelson <wabz@pidgin.im>
parents:
diff changeset
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
1e124a68997e gntgaim idle reporting, this fixes idle return
Richard Nelson <wabz@pidgin.im>
parents:
diff changeset
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1e124a68997e gntgaim idle reporting, this fixes idle return
Richard Nelson <wabz@pidgin.im>
parents:
diff changeset
16 * GNU General Public License for more details.
1e124a68997e gntgaim idle reporting, this fixes idle return
Richard Nelson <wabz@pidgin.im>
parents:
diff changeset
17 *
1e124a68997e gntgaim idle reporting, this fixes idle return
Richard Nelson <wabz@pidgin.im>
parents:
diff changeset
18 * You should have received a copy of the GNU General Public License
1e124a68997e gntgaim idle reporting, this fixes idle return
Richard Nelson <wabz@pidgin.im>
parents:
diff changeset
19 * 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: 16255
diff changeset
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
15802
1e124a68997e gntgaim idle reporting, this fixes idle return
Richard Nelson <wabz@pidgin.im>
parents:
diff changeset
21 */
35487
494f09f7f331 Move section blocks inside inclusion guards -- otherwise g-ir-scanner yells
Ankit Vani <a@nevitus.org>
parents: 35486
diff changeset
22
39885
b1b266896ec1 Fix the header guards for finch
Gary Kramlich <grim@reaperworld.com>
parents: 37094
diff changeset
23 #ifndef FINCH_IDLE_H
b1b266896ec1 Fix the header guards for finch
Gary Kramlich <grim@reaperworld.com>
parents: 37094
diff changeset
24 #define FINCH_IDLE_H
b1b266896ec1 Fix the header guards for finch
Gary Kramlich <grim@reaperworld.com>
parents: 37094
diff changeset
25
35449
c5f8cb0fb8ef Add sections for finch and re-arrange its doc index
Ankit Vani <a@nevitus.org>
parents: 35410
diff changeset
26 /**
c5f8cb0fb8ef Add sections for finch and re-arrange its doc index
Ankit Vani <a@nevitus.org>
parents: 35410
diff changeset
27 * SECTION:gntidle
c5f8cb0fb8ef Add sections for finch and re-arrange its doc index
Ankit Vani <a@nevitus.org>
parents: 35410
diff changeset
28 * @section_id: finch-gntidle
c5f8cb0fb8ef Add sections for finch and re-arrange its doc index
Ankit Vani <a@nevitus.org>
parents: 35410
diff changeset
29 * @short_description: <filename>gntidle.h</filename>
c5f8cb0fb8ef Add sections for finch and re-arrange its doc index
Ankit Vani <a@nevitus.org>
parents: 35410
diff changeset
30 * @title: Idle API
c5f8cb0fb8ef Add sections for finch and re-arrange its doc index
Ankit Vani <a@nevitus.org>
parents: 35410
diff changeset
31 */
c5f8cb0fb8ef Add sections for finch and re-arrange its doc index
Ankit Vani <a@nevitus.org>
parents: 35410
diff changeset
32
15802
1e124a68997e gntgaim idle reporting, this fixes idle return
Richard Nelson <wabz@pidgin.im>
parents:
diff changeset
33 #include "idle.h"
1e124a68997e gntgaim idle reporting, this fixes idle return
Richard Nelson <wabz@pidgin.im>
parents:
diff changeset
34
1e124a68997e gntgaim idle reporting, this fixes idle return
Richard Nelson <wabz@pidgin.im>
parents:
diff changeset
35 /**************************************************************************/
35472
474e26199560 Removed @name
Ankit Vani <a@nevitus.org>
parents: 35449
diff changeset
36 /* GNT Idle API */
15802
1e124a68997e gntgaim idle reporting, this fixes idle return
Richard Nelson <wabz@pidgin.im>
parents:
diff changeset
37 /**************************************************************************/
1e124a68997e gntgaim idle reporting, this fixes idle return
Richard Nelson <wabz@pidgin.im>
parents:
diff changeset
38
1e124a68997e gntgaim idle reporting, this fixes idle return
Richard Nelson <wabz@pidgin.im>
parents:
diff changeset
39 /**
35410
5a6336f20f6e Convert docs from doxygen to gtk-doc format for finch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
40 * finch_idle_get_ui_ops:
5a6336f20f6e Convert docs from doxygen to gtk-doc format for finch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
41 *
15802
1e124a68997e gntgaim idle reporting, this fixes idle return
Richard Nelson <wabz@pidgin.im>
parents:
diff changeset
42 * Returns the GNT idle UI ops.
1e124a68997e gntgaim idle reporting, this fixes idle return
Richard Nelson <wabz@pidgin.im>
parents:
diff changeset
43 *
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 20147
diff changeset
44 * Returns: The UI operations structure.
15802
1e124a68997e gntgaim idle reporting, this fixes idle return
Richard Nelson <wabz@pidgin.im>
parents:
diff changeset
45 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15878
diff changeset
46 PurpleIdleUiOps *finch_idle_get_ui_ops(void);
15802
1e124a68997e gntgaim idle reporting, this fixes idle return
Richard Nelson <wabz@pidgin.im>
parents:
diff changeset
47
39885
b1b266896ec1 Fix the header guards for finch
Gary Kramlich <grim@reaperworld.com>
parents: 37094
diff changeset
48 #endif /* FINCH_IDLE_H */
b1b266896ec1 Fix the header guards for finch
Gary Kramlich <grim@reaperworld.com>
parents: 37094
diff changeset
49

mercurial