Debian Codegraph @

test/docbook/source/classsynopsis.xml

raw
1 <chapter xmlns="http://docbook.org/ns/docbook"
2 id="classsynopsis">
3 <title>Class Synopses</title>
4
5 <section id="classsynopsis-cpp">
6 <title>C++</title>
7
8 <para>Here is a <sgmltag>classsynopsis</sgmltag>:</para>
9 <classsynopsis language="cpp">
10 <ooclass><classname>Button</classname></ooclass>
11 <ooclass><modifier>public</modifier><classname>Bin</classname></ooclass>
12 <constructorsynopsis>
13 <modifier>public</modifier>
14 <methodname>Button</methodname>
15 <void/>
16 </constructorsynopsis>
17 <constructorsynopsis>
18 <modifier>public</modifier>
19 <modifier>explicit</modifier>
20 <methodparam>
21 <modifier>const</modifier>
22 <type>Glib::ustring&amp;</type>
23 <parameter>label</parameter>
24 </methodparam>
25 <methodparam>
26 <type>bool</type>
27 <parameter>mnemonic</parameter>
28 <initializer>false</initializer>
29 </methodparam>
30 </constructorsynopsis>
31 <destructorsynopsis>
32 <modifier>public</modifier>
33 <modifier>virtual</modifier>
34 <void/>
35 </destructorsynopsis>
36 <fieldsynopsis>
37 <modifier>private</modifier>
38 <modifier>friend</modifier>
39 <type>class</type>
40 <varname>Button_Class</varname>
41 </fieldsynopsis>
42 <fieldsynopsis>
43 <modifier>private</modifier>
44 <modifier>static</modifier>
45 <type>CppClassType</type>
46 <varname>button_class_</varname>
47 </fieldsynopsis>
48 <methodsynopsis>
49 <modifier>protected</modifier>
50 <modifier>virtual</modifier>
51 <void/>
52 <methodname>on_pressed</methodname>
53 <void/>
54 </methodsynopsis>
55 <methodsynopsis>
56 <modifier>protected</modifier>
57 <modifier>virtual</modifier>
58 <void/>
59 <methodname>on_released</methodname>
60 <void/>
61 </methodsynopsis>
62 <methodsynopsis>
63 <modifier>protected</modifier>
64 <modifier>virtual</modifier>
65 <void/>
66 <methodname>on_clicked</methodname>
67 <void/>
68 </methodsynopsis>
69 <methodsynopsis>
70 <modifier>protected</modifier>
71 <modifier>virtual</modifier>
72 <void/>
73 <methodname>on_enter</methodname>
74 <void/>
75 </methodsynopsis>
76 <methodsynopsis>
77 <modifier>protected</modifier>
78 <modifier>virtual</modifier>
79 <void/>
80 <methodname>on_leave</methodname>
81 <void/>
82 </methodsynopsis>
83 <methodsynopsis>
84 <modifier>protected</modifier>
85 <modifier>virtual</modifier>
86 <void/>
87 <methodname>on_activate</methodname>
88 <void/>
89 </methodsynopsis>
90 <methodsynopsis>
91 <modifier>public</modifier>
92 <type>GType</type>
93 <methodname>get_type</methodname>
94 <void/>
95 <modifier>G_GNUC_CONST</modifier>
96 </methodsynopsis>
97 <methodsynopsis>
98 <modifier>public</modifier>
99 <type>GType</type>
100 <methodname>get_base_type</methodname>
101 <void/>
102 <modifier>G_GNUC_CONST</modifier>
103 </methodsynopsis>
104 <fieldsynopsis>
105 <modifier>public</modifier>
106 <modifier>static</modifier>
107 <type>bool</type>
108 <varname>fake</varname>
109 <initializer>true</initializer>
110 </fieldsynopsis>
111 </classsynopsis>
112
113 <para>Here is a standalone <sgmltag>methodsynopsis</sgmltag>:</para>
114 <methodsynopsis language="cpp">
115 <modifier>public</modifier>
116 <void/>
117 <methodname>frobnicate</methodname>
118 <methodparam><type>Foo</type><parameter>foo</parameter></methodparam>
119 <methodparam><modifier>const</modifier><type>bool</type><parameter>frob</parameter><initializer>true</initializer></methodparam>
120 <modifier>FROB</modifier>
121 </methodsynopsis>
122
123 </section> <!-- classsynopsis-cpp -->
124
125 <section id="classsynopsis-csharp">
126 <title>C#</title>
127 </section> <!-- classsynopsis-csharp -->
128
129 <section id="classsynopsis-java">
130 <title>Java</title>
131 </section> <!-- classsynopsis-java -->
132
133 <section id="classsynopsis-python">
134 <title>Python</title>
135
136 <para>Here is a <sgmltag>classsynopsis</sgmltag>:</para>
137 <classsynopsis language="python">
138 <ooclass><classname>gtk.Button</classname></ooclass>
139 <ooclass><classname>gtk.Bin</classname></ooclass>
140 <constructorsynopsis>
141 <methodparam>
142 <parameter>label</parameter>
143 <initializer>None</initializer>
144 </methodparam>
145 <methodparam>
146 <parameter>stock</parameter>
147 <initializer>None</initializer>
148 </methodparam>
149 <methodparam>
150 <parameter>use_underline</parameter>
151 <initializer>True</initializer>
152 </methodparam>
153 </constructorsynopsis>
154 <destructorsynopsis><void/></destructorsynopsis>
155 <methodsynopsis><methodname>pressed</methodname><void/></methodsynopsis>
156 <methodsynopsis><methodname>released</methodname><void/></methodsynopsis>
157 <methodsynopsis><methodname>clicked</methodname><void/></methodsynopsis>
158 <methodsynopsis><methodname>enter</methodname><void/></methodsynopsis>
159 <methodsynopsis><methodname>leave</methodname><void/></methodsynopsis>
160 <methodsynopsis>
161 <methodname>set_relief</methodname>
162 <methodparam><parameter>newstyle</parameter></methodparam>
163 </methodsynopsis>
164 <methodsynopsis><methodname>get_relief</methodname><void/></methodsynopsis>
165 <fieldsynopsis><varname>fake</varname><initializer>True</initializer></fieldsynopsis>
166 </classsynopsis>
167
168 <para>Here we use <sgmltag>modifier</sgmltag> for Python decorators:</para>
169 <classsynopsis language="python">
170 <ooclass><classname>Decorated</classname></ooclass>
171 <ooclass><classname>Base1</classname></ooclass>
172 <ooclass><classname>Base2</classname></ooclass>
173 <ooclass><classname>Base3</classname></ooclass>
174 <constructorsynopsis>
175 <modifier>@constructor</modifier>
176 <methodname>create</methodname>
177 <methodparam><parameter>input</parameter></methodparam>
178 </constructorsynopsis>
179 <destructorsynopsis>
180 <modifier>@destructor</modifier>
181 <methodname>destroy</methodname>
182 <void/>
183 </destructorsynopsis>
184 <fieldsynopsis>
185 <modifier>@private</modifier>
186 <varname>parts</varname>
187 <initializer>None</initializer>
188 </fieldsynopsis>
189 <methodsynopsis>
190 <modifier>@classmethod</modifier>
191 <methodname>find_all</methodname>
192 <void/>
193 </methodsynopsis>
194 </classsynopsis>
195
196 <para>Here we use annotations from
197 <ulink url="http://www.python.org/dev/peps/pep-3107/">PEP 3107</ulink>:</para>
198 <methodsynopsis language="python">
199 <type>Frobnicated</type>
200 <methodname>frobnicate</methodname>
201 <methodparam>
202 <type>Frobnicatable</type>
203 <parameter>frob</parameter>
204 </methodparam>
205 <methodparam>
206 <type>bool</type>
207 <parameter>thorough</parameter>
208 <initializer>False</initializer>
209 </methodparam>
210 </methodsynopsis>
211
212 </section> <!-- classsynopsis-python -->
213
214 </chapter>