libpurple/purplewhiteboardops.h

Sun, 12 Dec 2021 02:57:11 -0600

author
Gary Kramlich <grim@reaperworld.com>
date
Sun, 12 Dec 2021 02:57:11 -0600
changeset 41205
c5513eb740aa
parent 40595
d7e28f8a0994
child 41276
03f98ece6b26
permissions
-rw-r--r--

Remove unnecessary gtk-doc comments and move them where possible from libpurple/purple[o-z]*.h

Testing Done:
Compiled

Reviewed at https://reviews.imfreedom.org/r/1182/

40595
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
1 /*
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
2 * Purple - Internet Messaging Library
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
3 * Copyright (C) Pidgin Developers <devel@pidgin.im>
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
4 *
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
5 * Purple is the legal property of its developers, whose names are too numerous
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
6 * to list here. Please refer to the COPYRIGHT file distributed with this
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
7 * source distribution.
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
8 *
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
9 * This program is free software; you can redistribute it and/or modify
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
10 * it under the terms of the GNU General Public License as published by
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
11 * the Free Software Foundation; either version 2 of the License, or
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
12 * (at your option) any later version.
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
13 *
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
14 * This program is distributed in the hope that it will be useful,
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
17 * GNU General Public License for more details.
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
18 *
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
19 * You should have received a copy of the GNU General Public License
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
20 * along with this program; if not, see <https://www.gnu.org/licenses/>.
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
21 */
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
22
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
23 #if !defined(PURPLE_GLOBAL_HEADER_INSIDE) && !defined(PURPLE_COMPILATION)
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
24 # error "only <pidgin.h> may be included directly"
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
25 #endif
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
26
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
27 #ifndef PURPLE_WHITEBOARD_OPS_H
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
28 #define PURPLE_WHITEBOARD_OPS_H
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
29
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
30 #include <glib.h>
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
31
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
32 typedef struct _PurpleWhiteboardOps PurpleWhiteboardOps;
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
33
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
34 #include "purplewhiteboard.h"
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
35
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
36 G_BEGIN_DECLS
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
37
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
38 /**
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
39 * PurpleWhiteboardOps:
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
40 * @start: start function
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
41 * @end: end function
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
42 * @get_dimensions: get whiteboard dimensions
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
43 * @set_dimensions: set whiteboard dimensions
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
44 * @get_brush: get the brush size and color
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
45 * @set_brush: set the brush size and color
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
46 * @send_draw_list: send_draw_list function
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
47 * @clear: clear whiteboard
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
48 *
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
49 * Whiteboard protocol operations
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
50 */
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
51 struct _PurpleWhiteboardOps
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
52 {
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
53 void (*start)(PurpleWhiteboard *wb);
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
54 void (*end)(PurpleWhiteboard *wb);
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
55 void (*get_dimensions)(const PurpleWhiteboard *wb, int *width, int *height);
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
56 void (*set_dimensions)(PurpleWhiteboard *wb, int width, int height);
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
57 void (*get_brush) (const PurpleWhiteboard *wb, int *size, int *color);
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
58 void (*set_brush) (PurpleWhiteboard *wb, int size, int color);
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
59 void (*send_draw_list)(PurpleWhiteboard *wb, GList *draw_list);
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
60 void (*clear)(PurpleWhiteboard *wb);
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
61
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
62 /*< private >*/
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
63 gpointer reserved[4];
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
64 };
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
65
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
66 G_END_DECLS
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
67
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
68 #endif /* PURPLE_WHITEBOARD_OPS_H */

mercurial