a56681cce490f52cde914823c787f9567b2692de
[cl-gtk2.git] / doc / gobject.texi
1 \input texinfo  @c -*-texinfo-*-
2 @c %**start of header (This is for running texinfo on a region.)
3 @setfilename gobject.info
4 @settitle CL-Gtk2-GObject
5 @c %**end of header (This is for running texinfo on a region.)
6
7 @c @documentencoding utf-8
8
9 @macro Function {args}
10 @defun \args\
11 @end defun
12 @end macro
13
14 @macro Macro {args}
15 @defmac \args\
16 @end defmac
17 @end macro
18
19 @macro Struct {args}
20 @deftp {Structure} \args\
21 @end deftp
22 @end macro
23
24 @macro Class {args}
25 @deftp {Class} \args\
26 @end deftp
27 @end macro
28
29 @macro Accessor {args}
30 @deffn {Accessor} \args\
31 @end deffn
32 @end macro
33
34 @macro GenericFunction {args}
35 @deffn {Generic Function} \args\
36 @end deffn
37 @end macro
38
39 @macro ForeignType {args}
40 @deftp {Foreign Type} \args\
41 @end deftp
42 @end macro
43
44 @macro Variable {args}
45 @defvr {Special Variable} \args\
46 @end defvr
47 @end macro
48
49 @macro Condition {args}
50 @deftp {Condition Type} \args\
51 @end deftp
52 @end macro
53
54 @macro cffi
55 @acronym{CFFI}
56 @end macro
57
58 @macro impnote {text}
59 @quotation
60 @strong{Implementor's note:} @emph{\text\}
61 @end quotation
62 @end macro
63
64 @c Info "requires" that x-refs end in a period or comma, or ) in the
65 @c case of @pxref.  So the following implements that requirement for
66 @c the "See also" subheadings that permeate this manual, but only in
67 @c Info mode.
68 @ifinfo
69 @macro seealso {name}
70 @ref{\name\}.
71 @end macro
72 @end ifinfo
73
74 @ifnotinfo
75 @alias seealso = ref
76 @end ifnotinfo
77
78 @c Typeset comments in roman font for the TeX output.
79 @iftex
80 @alias lispcmt = r
81 @end iftex
82 @ifnottex
83 @alias lispcmt = asis
84 @end ifnottex
85
86 @c My copy of makeinfo is not generating any HTML for @result{} for
87 @c some odd reason. (It certainly used to...)
88 @ifhtml
89 @macro result
90 =>
91 @end macro
92 @end ifhtml
93
94 @c Similar macro to @result. Its purpose is to work around the fact
95 @c that ⇒ does not work properly inside @lisp.
96 @ifhtml
97 @macro res
98 @html
99 ⇒
100 @end html
101 @end macro
102 @end ifhtml
103
104 @ifnothtml
105 @alias res = result
106 @end ifnothtml
107
108 @c ============================= Macros =============================
109
110
111 @c Show types, functions, and concepts in the same index.
112 @syncodeindex tp cp
113 @syncodeindex fn cp
114
115 @titlepage
116 @title CL-GTK2
117 @subtitle A Common Lisp binding for Gtk+
118 @subtitle GObject
119 @author Dmitry Kalyanov
120 @end titlepage
121
122 @contents
123
124 @ifnottex
125 @node Top
126 @top cl-gtk2-gobject
127 @end ifnottex
128
129 @include gobject.ref.texi
130
131 @bye
132