Update documentation for stale FcConfigGetConfig function.
[platform/upstream/fontconfig.git] / doc / fcobjectset.fncs
1 /*
2  * $Id$
3  *
4  * Copyright © 2003 Keith Packard
5  *
6  * Permission to use, copy, modify, distribute, and sell this software and its
7  * documentation for any purpose is hereby granted without fee, provided that
8  * the above copyright notice appear in all copies and that both that
9  * copyright notice and this permission notice appear in supporting
10  * documentation, and that the name of Keith Packard not be used in
11  * advertising or publicity pertaining to distribution of the software without
12  * specific, written prior permission.  Keith Packard makes no
13  * representations about the suitability of this software for any purpose.  It
14  * is provided "as is" without express or implied warranty.
15  *
16  * KEITH PACKARD DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
17  * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
18  * EVENT SHALL KEITH PACKARD BE LIABLE FOR ANY SPECIAL, INDIRECT OR
19  * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
20  * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
21  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
22  * PERFORMANCE OF THIS SOFTWARE.
23  */
24 @RET@           FcObjectSet *
25 @FUNC@          FcObjectSetCreate
26 @TYPE1@         void
27 @PURPOSE@       Create an object set
28 @DESC@
29 Creates an empty set.
30 @@
31
32 @RET@           FcBool
33 @FUNC@          FcObjectSetAdd
34 @TYPE1@         FcObjectSet *                   @ARG1@          os
35 @TYPE2@         const char *                    @ARG2@          object
36 @PURPOSE@       Add to an object set
37 @DESC@
38 Adds a proprety name to the set.
39 @@
40
41 @RET@           void
42 @FUNC@          FcObjectSetDestroy
43 @TYPE1@         FcObjectSet *                   @ARG1@          os
44 @PURPOSE@       Destroy an object set
45 @DESC@
46 Destroys an object set.
47 @@
48
49 @RET@           FcObjectSet *
50 @FUNC@          FcObjectSetBuild
51 @TYPE1@         const char *                    @ARG1@          first
52 @TYPE2@         ...
53 @PROTOTYPE+@
54 @RET+@          FcObjectSet *
55 @FUNC+@         FcObjectSetVaBuild
56 @TYPE1+@        const char *                    @ARG1+@         first
57 @TYPE2+@        va_list%                        @ARG2+@         va
58 @PURPOSE@       Build object set from args
59 @DESC@
60 These build an object set from a null-terminated list of property names.
61 @@