finch/finch.h.in

Tue, 25 Aug 2020 23:18:09 -0500

author
Gary Kramlich <grim@reaperworld.com>
date
Tue, 25 Aug 2020 23:18:09 -0500
changeset 40524
a3b1cde8d2d8
parent 40508
2ebcb8eb5c01
child 40539
2941deda6d8d
permissions
-rw-r--r--

Add documentation for all PURPLE_TYPE_ functions as well as PURPLE_TUNE_ constants

Add document for all PURPLE_TYPE_ defines as well as PURPLE_TUNE_ constants

Testing Done:
Compile and doc build.

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

40508
2ebcb8eb5c01 create a global header for finch
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
1 /*
2ebcb8eb5c01 create a global header for finch
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
2 * finch
2ebcb8eb5c01 create a global header for finch
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
3 *
2ebcb8eb5c01 create a global header for finch
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
4 * Finch is the legal property of its developers, whose names are too numerous
2ebcb8eb5c01 create a global header for finch
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
5 * to list here. Please refer to the COPYRIGHT file distributed with this
2ebcb8eb5c01 create a global header for finch
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
6 * source distribution.
2ebcb8eb5c01 create a global header for finch
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
7 *
2ebcb8eb5c01 create a global header for finch
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
8 * This program is free software; you can redistribute it and/or modify
2ebcb8eb5c01 create a global header for finch
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
9 * it under the terms of the GNU General Public License as published by
2ebcb8eb5c01 create a global header for finch
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
10 * the Free Software Foundation; either version 2 of the License, or
2ebcb8eb5c01 create a global header for finch
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
11 * (at your option) any later version.
2ebcb8eb5c01 create a global header for finch
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
12 *
2ebcb8eb5c01 create a global header for finch
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
13 * This program is distributed in the hope that it will be useful,
2ebcb8eb5c01 create a global header for finch
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
2ebcb8eb5c01 create a global header for finch
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
2ebcb8eb5c01 create a global header for finch
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
16 * GNU General Public License for more details.
2ebcb8eb5c01 create a global header for finch
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
17 *
2ebcb8eb5c01 create a global header for finch
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
18 * You should have received a copy of the GNU General Public License
2ebcb8eb5c01 create a global header for finch
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
19 * along with this program; if not, see <http://www.gnu.org/licenses/>.
2ebcb8eb5c01 create a global header for finch
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
20 */
2ebcb8eb5c01 create a global header for finch
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
21
2ebcb8eb5c01 create a global header for finch
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
22 #ifndef FINCH_H
2ebcb8eb5c01 create a global header for finch
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
23 #define FINCH_H
2ebcb8eb5c01 create a global header for finch
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
24
2ebcb8eb5c01 create a global header for finch
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
25 #ifndef FINCH_GLOBAL_HEADER_INSIDE
2ebcb8eb5c01 create a global header for finch
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
26 #define FINCH_GLOBAL_HEADER_INSIDE
2ebcb8eb5c01 create a global header for finch
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
27 #endif
2ebcb8eb5c01 create a global header for finch
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
28
2ebcb8eb5c01 create a global header for finch
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
29 @FINCH_H_INCLUDES@
2ebcb8eb5c01 create a global header for finch
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
30
2ebcb8eb5c01 create a global header for finch
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
31 #undef FINCH_GLOBAL_HEADER_INSIDE
2ebcb8eb5c01 create a global header for finch
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
32
2ebcb8eb5c01 create a global header for finch
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
33 #endif /* FINCH_H */

mercurial