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