1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
[
<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
<!ENTITY % gtkdocentities SYSTEM "xml/gtkdocentities.ent">
%gtkdocentities;
]>
<part id="api-breaks">
<title>API Breaks</title>
<para>
Devhelp is a quite old piece of software (created in 2001), and as every
software, the code evolves during its lifetime. So there are sometimes API
breaks. We try to not break applications depending on the Devhelp API. But
if we see that a certain API is used nowhere else than the Devhelp
application itself (or is dead code), we don't hesitate to break the API to
improve the code.
</para>
<para>
Currently we try to not break
<ulink url="https://wiki.gnome.org/Apps/Anjuta">Anjuta</ulink>
and <ulink url="https://wiki.gnome.org/Apps/Builder">gnome-builder</ulink>.
If your application is not listed and depends on the Devhelp API and is Free
Software, please speak up.
</para>
<refsect1>
<title>3.29.1 -> 3.29.2</title>
<itemizedlist>
<listitem>
<para>
<link linkend="DhBookManager">DhBookManager</link> is now completely
empty and entirely deprecated, the minimum amount of API is kept to
not break Anjuta. It has been replaced by a more flexible
infrastructure: <link linkend="DhProfile">DhProfile</link>,
<link linkend="DhSettings">DhSettings</link> and
<link linkend="DhBookList">DhBookList</link>. If your application uses
only the default libdevhelp widgets it will still work fine – even if
you don't adapt the code of the application – because in that case it
will use the default <link linkend="DhProfile">DhProfile</link>, which
contains the same content as how
<link linkend="DhBookManager">DhBookManager</link> was implemented.
</para>
</listitem>
<listitem>
<para>
Whether a <link linkend="DhBook">DhBook</link> is enabled/selected is
now decoupled from <link linkend="DhBook">DhBook</link>:
<code>dh_book_get_enabled()</code> and
<code>dh_book_set_enabled()</code> have been removed, as well as the
<code>DhBook::enabled</code> and <code>DhBook::disabled</code>
signals. For a book to be enabled it now needs to be part
of a <link linkend="DhBookList">DhBookList</link>, which is more
flexible because there can be several different
<link linkend="DhBookList">DhBookList</link>'s in parallel.
</para>
</listitem>
<listitem>
<para>
The last parameter of
<link linkend="dh-keyword-model-filter">dh_keyword_model_filter()</link>
has been changed, it is no longer the language (a string, that
parameter was deprecated), it is a nullable
<link linkend="DhProfile">DhProfile</link>.
</para>
</listitem>
<listitem>
<para>
<code>dh_book_tree_get_selected_book()</code> has been replaced by
<link linkend="dh-book-tree-get-selected-link">dh_book_tree_get_selected_link()</link>.
</para>
</listitem>
</itemizedlist>
</refsect1>
<refsect1>
<title>3.28.0 -> 3.29.1</title>
<itemizedlist>
<listitem>
<para>
The <code>DhBookManager:group-by-language</code> property has been
replaced by the
<link linkend="DhSettings--group-books-by-language">DhSettings:group-books-by-language</link>
property.
</para>
</listitem>
<listitem>
<para>
<link linkend="dh-book-tree-new">dh_book_tree_new()</link> now takes a
<link linkend="DhProfile">DhProfile</link> parameter.
</para>
</listitem>
</itemizedlist>
</refsect1>
<refsect1>
<title>3.27.1 -> 3.27.2</title>
<itemizedlist>
<listitem>
<para>
<code>dh_book_cmp_by_path()</code> has been removed (dead code).
</para>
</listitem>
<listitem>
<para>
The <code>DhBookManager::language-enabled</code> and
<code>DhBookManager::language-disabled</code> signals have been
removed (dead code).
</para>
</listitem>
<listitem>
<para>
<link linkend="DhSidebar">DhSidebar</link> is now a subclass of
<link linkend="GtkGrid">GtkGrid</link>, not
<link linkend="GtkBox">GtkBox</link>.
</para>
</listitem>
<listitem>
<para>
<code>dh_sidebar_get_selected_book()</code> has been removed (it was
used only inside DhSidebar).
</para>
</listitem>
<listitem>
<para>
<code>dh_book_get_completions()</code> has been replaced by
<link linkend="dh-book-get-completion">dh_book_get_completion()</link>.
</para>
</listitem>
</itemizedlist>
</refsect1>
<refsect1>
<title>3.26.0 -> 3.27.1</title>
<itemizedlist>
<listitem>
<para>
<link linkend="dh-link-new">dh_link_new()</link> has been split in
two, with <link linkend="dh-link-new-book">dh_link_new_book()</link>
to create a <link linkend="DhLink">DhLink</link> of type
<link linkend="DH-LINK-TYPE-BOOK:CAPS">DH_LINK_TYPE_BOOK</link>.
</para>
</listitem>
<listitem>
<para>
The <code>dh_link_get_file_name()</code> function has been removed.
</para>
</listitem>
<listitem>
<para>
The <code>dh_book_get_path()</code> function has been replaced by
<link linkend="dh-book-get-index-file">dh_book_get_index_file()</link>.
</para>
</listitem>
<listitem>
<para>
The <link linkend="dh-book-new">dh_book_new()</link> constructor now
takes a <code>GFile</code> argument instead of a path.
</para>
</listitem>
<listitem>
<para>
<code>dh_book_get_name()</code> has been renamed to
<link linkend="dh-book-get-id">dh_book_get_id()</link>.
</para>
</listitem>
<listitem>
<para>
<code>dh_book_cmp_by_name()</code> has been renamed to
<link linkend="dh-book-cmp-by-id">dh_book_cmp_by_id()</link>.
</para>
</listitem>
<listitem>
<para>
<code>dh_link_get_book_name()</code> has been renamed to
<link linkend="dh-link-get-book-title">dh_link_get_book_title()</link>.
</para>
</listitem>
<listitem>
<para>
<code>dh_book_get_keywords()</code> has been renamed to
<link linkend="dh-book-get-links">dh_book_get_links()</link>.
</para>
</listitem>
<listitem>
<para>
The ownership transfer of the return values of
<code>dh_book_tree_get_selected_book()</code>
and <code>dh_sidebar_get_selected_book()</code>
have been changed from (transfer none) to (transfer full).
</para>
</listitem>
</itemizedlist>
</refsect1>
<refsect1>
<title>3.25.1 -> 3.25.2</title>
<itemizedlist>
<listitem>
<para>
The <code>page</code> parameter of <link linkend="dh-link-new">dh_link_new()</link>
has been removed because it was broken in <code>dh-parser.c</code>.
The <code>book</code> parameter has also been moved, to group related
parameters together.
</para>
</listitem>
<listitem>
<para>
The <code>dh_link_get_page_name()</code> function has been removed
because it was broken and used nowhere.
</para>
</listitem>
<listitem>
<para>
The <code>dh_link_get_type_as_string()</code> function (which took a
<link linkend="DhLink">DhLink</link> parameter) has been removed, it
has been replaced by <link linkend="dh-link-type-to-string">dh_link_type_to_string()</link>
which takes a <link linkend="DhLinkType">DhLinkType</link> parameter.
</para>
</listitem>
</itemizedlist>
</refsect1>
<refsect1>
<title>3.24 -> 3.25.1</title>
<itemizedlist>
<listitem>
<para>
All deprecated APIs have been removed.
</para>
</listitem>
<listitem>
<para>
dh-error.h is now private.
</para>
</listitem>
<listitem>
<para>
The <code>DhApp</code>, <code>DhAssistant</code> and
<code>DhWindow</code> classes are now private. <code>DhApp</code> is a
subclass of <code>GtkApplication</code>, and an application can have
only one <code>GtkApplication</code> instance, so as-is
<code>DhApp</code> didn't make sense in the library (what if two
different libraries have both a subclass of
<code>GtkApplication</code>?). Since <code>DhAssistant</code> and
<code>DhWindow</code> depend on <code>DhApp</code>, they are now also
private.
</para>
</listitem>
<listitem>
<para>
The <code>DhLanguage</code> class is now private, it's currently used
only internally by <link linkend="DhBookManager">DhBookManager</link>.
</para>
</listitem>
<listitem>
<para>
Due to <link linkend="DhBookManager">DhBookManager</link> being now a
singleton, there has been the following API changes:
<itemizedlist>
<listitem>
<para>
<code>dh_assistant_view_set_book_manager()</code> has been
removed.
</para>
</listitem>
<listitem>
<para>
<code>dh_keyword_model_set_words()</code> has been removed.
</para>
</listitem>
<listitem>
<para>
The <code>DhBookTree:book-manager</code> property has been
removed.
</para>
</listitem>
<listitem>
<para>
API break for
<link linkend="dh-book-tree-new">dh_book_tree_new()</link>.
</para>
</listitem>
<listitem>
<para>
The <code>DhSidebar:book-manager</code> property has been
removed.
</para>
</listitem>
<listitem>
<para>
The <code>book_manager</code> parameter of
<link linkend="dh-sidebar-new">dh_sidebar_new()</link> is now
deprecated.
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
</itemizedlist>
</refsect1>
</part>
|
