finch/gntpounce.h

Sun, 09 Feb 2014 23:17:20 +0530

author
Ankit Vani <a@nevitus.org>
date
Sun, 09 Feb 2014 23:17:20 +0530
branch
gtkdoc-conversion
changeset 35496
a28ece02876c
parent 35487
494f09f7f331
child 37100
a243a5e7afb3
permissions
-rw-r--r--

Fix some annotation warnings in finch

20147
66f05a854eee applied changes from 8a731bbd0197fbcc91a705c2d8f528154216defa
Richard Laager <rlaager@pidgin.im>
parents: 19859
diff changeset
1 /* finch
15564
61befe113a13 Wonderful patch from Richard 'wabz' Nelson to fix the bug of lacking a pounce ui.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
2 *
15931
716b5fac1895 Re-sed the copyright notices so they don't all talk about Purple.
Richard Laager <rlaager@pidgin.im>
parents: 15906
diff changeset
3 * Finch is the legal property of its developers, whose names are too numerous
15564
61befe113a13 Wonderful patch from Richard 'wabz' Nelson to fix the bug of lacking a pounce ui.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
4 * to list here. Please refer to the COPYRIGHT file distributed with this
61befe113a13 Wonderful patch from Richard 'wabz' Nelson to fix the bug of lacking a pounce ui.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
5 * source distribution.
61befe113a13 Wonderful patch from Richard 'wabz' Nelson to fix the bug of lacking a pounce ui.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
6 *
61befe113a13 Wonderful patch from Richard 'wabz' Nelson to fix the bug of lacking a pounce ui.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
7 * This program is free software; you can redistribute it and/or modify
61befe113a13 Wonderful patch from Richard 'wabz' Nelson to fix the bug of lacking a pounce ui.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
8 * it under the terms of the GNU General Public License as published by
61befe113a13 Wonderful patch from Richard 'wabz' Nelson to fix the bug of lacking a pounce ui.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
9 * the Free Software Foundation; either version 2 of the License, or
61befe113a13 Wonderful patch from Richard 'wabz' Nelson to fix the bug of lacking a pounce ui.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
10 * (at your option) any later version.
61befe113a13 Wonderful patch from Richard 'wabz' Nelson to fix the bug of lacking a pounce ui.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
11 *
61befe113a13 Wonderful patch from Richard 'wabz' Nelson to fix the bug of lacking a pounce ui.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
12 * This program is distributed in the hope that it will be useful,
61befe113a13 Wonderful patch from Richard 'wabz' Nelson to fix the bug of lacking a pounce ui.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
61befe113a13 Wonderful patch from Richard 'wabz' Nelson to fix the bug of lacking a pounce ui.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
61befe113a13 Wonderful patch from Richard 'wabz' Nelson to fix the bug of lacking a pounce ui.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
15 * GNU General Public License for more details.
61befe113a13 Wonderful patch from Richard 'wabz' Nelson to fix the bug of lacking a pounce ui.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
16 *
61befe113a13 Wonderful patch from Richard 'wabz' Nelson to fix the bug of lacking a pounce ui.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
17 * You should have received a copy of the GNU General Public License
61befe113a13 Wonderful patch from Richard 'wabz' Nelson to fix the bug of lacking a pounce ui.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
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: 16255
diff changeset
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
15564
61befe113a13 Wonderful patch from Richard 'wabz' Nelson to fix the bug of lacking a pounce ui.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
20 */
35487
494f09f7f331 Move section blocks inside inclusion guards -- otherwise g-ir-scanner yells
Ankit Vani <a@nevitus.org>
parents: 35449
diff changeset
21
494f09f7f331 Move section blocks inside inclusion guards -- otherwise g-ir-scanner yells
Ankit Vani <a@nevitus.org>
parents: 35449
diff changeset
22 #ifndef _FINCHPOUNCE_H_
494f09f7f331 Move section blocks inside inclusion guards -- otherwise g-ir-scanner yells
Ankit Vani <a@nevitus.org>
parents: 35449
diff changeset
23 #define _FINCHPOUNCE_H_
35449
c5f8cb0fb8ef Add sections for finch and re-arrange its doc index
Ankit Vani <a@nevitus.org>
parents: 35410
diff changeset
24 /**
c5f8cb0fb8ef Add sections for finch and re-arrange its doc index
Ankit Vani <a@nevitus.org>
parents: 35410
diff changeset
25 * SECTION:gntpounce
c5f8cb0fb8ef Add sections for finch and re-arrange its doc index
Ankit Vani <a@nevitus.org>
parents: 35410
diff changeset
26 * @section_id: finch-gntpounce
c5f8cb0fb8ef Add sections for finch and re-arrange its doc index
Ankit Vani <a@nevitus.org>
parents: 35410
diff changeset
27 * @short_description: <filename>gntpounce.h</filename>
c5f8cb0fb8ef Add sections for finch and re-arrange its doc index
Ankit Vani <a@nevitus.org>
parents: 35410
diff changeset
28 * @title: Buddy Pounce API
c5f8cb0fb8ef Add sections for finch and re-arrange its doc index
Ankit Vani <a@nevitus.org>
parents: 35410
diff changeset
29 */
c5f8cb0fb8ef Add sections for finch and re-arrange its doc index
Ankit Vani <a@nevitus.org>
parents: 35410
diff changeset
30
15564
61befe113a13 Wonderful patch from Richard 'wabz' Nelson to fix the bug of lacking a pounce ui.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
31 #include "pounce.h"
61befe113a13 Wonderful patch from Richard 'wabz' Nelson to fix the bug of lacking a pounce ui.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
32
61befe113a13 Wonderful patch from Richard 'wabz' Nelson to fix the bug of lacking a pounce ui.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
33 /**
35410
5a6336f20f6e Convert docs from doxygen to gtk-doc format for finch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
34 * finch_pounce_editor_show:
35393
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 20147
diff changeset
35 * @account: The optional account to use.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 20147
diff changeset
36 * @name: The optional name to pounce on.
00f876b129bc Initial replacements for gtk-doc style comments
Ankit Vani <a@nevitus.org>
parents: 20147
diff changeset
37 * @cur_pounce: The current buddy pounce, if editing an existing one.
35410
5a6336f20f6e Convert docs from doxygen to gtk-doc format for finch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
38 *
5a6336f20f6e Convert docs from doxygen to gtk-doc format for finch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
39 * Displays a New Buddy Pounce or Edit Buddy Pounce dialog.
15564
61befe113a13 Wonderful patch from Richard 'wabz' Nelson to fix the bug of lacking a pounce ui.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
40 */
15884
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15878
diff changeset
41 void finch_pounce_editor_show(PurpleAccount *account, const char *name,
4de1981757fc sed -ie 's/gaim/purple/g'
Sean Egan <seanegan@pidgin.im>
parents: 15878
diff changeset
42 PurplePounce *cur_pounce);
15564
61befe113a13 Wonderful patch from Richard 'wabz' Nelson to fix the bug of lacking a pounce ui.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
43
61befe113a13 Wonderful patch from Richard 'wabz' Nelson to fix the bug of lacking a pounce ui.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
44 /**
35410
5a6336f20f6e Convert docs from doxygen to gtk-doc format for finch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
45 * finch_pounces_manager_show:
5a6336f20f6e Convert docs from doxygen to gtk-doc format for finch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
46 *
15564
61befe113a13 Wonderful patch from Richard 'wabz' Nelson to fix the bug of lacking a pounce ui.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
47 * Shows the pounces manager window.
61befe113a13 Wonderful patch from Richard 'wabz' Nelson to fix the bug of lacking a pounce ui.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
48 */
15878
f52832b611fe renamed gaim-text to finch
Sean Egan <seanegan@pidgin.im>
parents: 15564
diff changeset
49 void finch_pounces_manager_show(void);
15564
61befe113a13 Wonderful patch from Richard 'wabz' Nelson to fix the bug of lacking a pounce ui.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
50
61befe113a13 Wonderful patch from Richard 'wabz' Nelson to fix the bug of lacking a pounce ui.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
51 /**
35410
5a6336f20f6e Convert docs from doxygen to gtk-doc format for finch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
52 * finch_pounces_manager_hide:
5a6336f20f6e Convert docs from doxygen to gtk-doc format for finch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
53 *
15564
61befe113a13 Wonderful patch from Richard 'wabz' Nelson to fix the bug of lacking a pounce ui.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
54 * Hides the pounces manager window.
61befe113a13 Wonderful patch from Richard 'wabz' Nelson to fix the bug of lacking a pounce ui.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
55 */
15878
f52832b611fe renamed gaim-text to finch
Sean Egan <seanegan@pidgin.im>
parents: 15564
diff changeset
56 void finch_pounces_manager_hide(void);
15564
61befe113a13 Wonderful patch from Richard 'wabz' Nelson to fix the bug of lacking a pounce ui.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
57
61befe113a13 Wonderful patch from Richard 'wabz' Nelson to fix the bug of lacking a pounce ui.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
58 /**
35410
5a6336f20f6e Convert docs from doxygen to gtk-doc format for finch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
59 * finch_pounces_get_handle:
5a6336f20f6e Convert docs from doxygen to gtk-doc format for finch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
60 *
35496
a28ece02876c Fix some annotation warnings in finch
Ankit Vani <a@nevitus.org>
parents: 35487
diff changeset
61 * Returns the GNT pounces handle
15564
61befe113a13 Wonderful patch from Richard 'wabz' Nelson to fix the bug of lacking a pounce ui.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
62 *
35496
a28ece02876c Fix some annotation warnings in finch
Ankit Vani <a@nevitus.org>
parents: 35487
diff changeset
63 * Returns: (transfer none): The handle to the GNT pounces system
15564
61befe113a13 Wonderful patch from Richard 'wabz' Nelson to fix the bug of lacking a pounce ui.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
64 */
15878
f52832b611fe renamed gaim-text to finch
Sean Egan <seanegan@pidgin.im>
parents: 15564
diff changeset
65 void *finch_pounces_get_handle(void);
15564
61befe113a13 Wonderful patch from Richard 'wabz' Nelson to fix the bug of lacking a pounce ui.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
66
61befe113a13 Wonderful patch from Richard 'wabz' Nelson to fix the bug of lacking a pounce ui.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
67 /**
35410
5a6336f20f6e Convert docs from doxygen to gtk-doc format for finch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
68 * finch_pounces_init:
5a6336f20f6e Convert docs from doxygen to gtk-doc format for finch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
69 *
15564
61befe113a13 Wonderful patch from Richard 'wabz' Nelson to fix the bug of lacking a pounce ui.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
70 * Initializes the GNT pounces subsystem.
61befe113a13 Wonderful patch from Richard 'wabz' Nelson to fix the bug of lacking a pounce ui.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
71 */
15878
f52832b611fe renamed gaim-text to finch
Sean Egan <seanegan@pidgin.im>
parents: 15564
diff changeset
72 void finch_pounces_init(void);
15564
61befe113a13 Wonderful patch from Richard 'wabz' Nelson to fix the bug of lacking a pounce ui.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
73
61befe113a13 Wonderful patch from Richard 'wabz' Nelson to fix the bug of lacking a pounce ui.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
74 /**
35410
5a6336f20f6e Convert docs from doxygen to gtk-doc format for finch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
75 * finch_pounces_uninit:
5a6336f20f6e Convert docs from doxygen to gtk-doc format for finch
Ankit Vani <a@nevitus.org>
parents: 35393
diff changeset
76 *
15564
61befe113a13 Wonderful patch from Richard 'wabz' Nelson to fix the bug of lacking a pounce ui.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
77 * Uninitializes the GNT pounces subsystem.
61befe113a13 Wonderful patch from Richard 'wabz' Nelson to fix the bug of lacking a pounce ui.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
78 */
15878
f52832b611fe renamed gaim-text to finch
Sean Egan <seanegan@pidgin.im>
parents: 15564
diff changeset
79 void finch_pounces_uninit(void);
15564
61befe113a13 Wonderful patch from Richard 'wabz' Nelson to fix the bug of lacking a pounce ui.
Sadrul Habib Chowdhury <sadrul@pidgin.im>
parents:
diff changeset
80
35496
a28ece02876c Fix some annotation warnings in finch
Ankit Vani <a@nevitus.org>
parents: 35487
diff changeset
81 #endif /* _PURPLE_FINCHPOUNCE_H_ */

mercurial