Debian Codegraph @

geanygendoc/ChangeLog

raw
1 2010-08-17 Colomban Wendling <ban(at)herbesfolles(dot)org>
2
3 * docs/manual.rst, docs/manual.html:
4 Add license information in the manual.
5 * docs/manual.css:
6 Add a style definition for blockquotes in the manual stylesheet.
7 * docs/manual.rst, docs/manual.html:
8 Move "User interface in Geany" part on the top of the manual. This part is
9 probably the first new users would look at, then move it to the top.
10 * docs/manual.rst, docs/manual.html:
11 Add a small sentence in the introduction to guide the user in her read.
12 * README.in, HACKING:
13 Update README.in, add HACKING.
14 * ../build/geanygendoc.m4, README.in -> README:
15 Don't pre-process README anymore. It isn't needed anymore since the version
16 number was removed, and this version number was wrong anyway since the the
17 plugin is part of Geany-plugins.
18
19
20 2010-06-14 Colomban Wendling <ban(at)herbesfolles(dot)org>
21
22 * src/ggd-plugin.h:
23 Post-release version bump.
24 * src/ggd.c:
25 Update a string.
26 * src/ggd-tag-utils.c:
27 Use Geany's symbols_get_context_separator() and not a copied version since
28 it is now exported to the plugin API since 185.
29 * src/ggd-widget-doctype-selector.c:
30 Add a popup menu.
31
32
33 2010-06-12 Colomban Wendling <ban(at)herbesfolles(dot)org>
34
35 * src/ggd-tag-utils.c:
36 Fix finding of tag's children. Pretty hackish fix but it now works even if
37 there is two top-level tags sharing the same name.
38 * NEWS:
39 Update NEWS file.
40 * src/ggd-plugin.c, src/ggd-plugin.h:
41 Use non-Geany-Plugin version.
42
43
44 2010-06-04 Colomban Wendling <ban(at)herbesfolles(dot)org>
45
46 * src/ggd.c:
47 Fix crash when trying to generate documentation for a document with
48 doc->tm_file == NULL, which is the case e.g. for None file type.
49 * src/ggd-tag-utils.c:
50 Fix finding the parent of a tag if this parent have the same name and
51 scope than another tag in the document.
52
53
54 2010-06-03 Colomban Wendling <ban(at)herbesfolles(dot)org>
55
56 * src/ggd-plugin.c:
57 Use new PLUGIN_SET_TRANSLATABLE_INFO() macro
58
59
60 2010-05-27 Colomban Wendling <ban(at)herbesfolles(dot)org>
61
62 * docs/Makefile.am, docs/help/Makefile.am -> docs/Makefile.am,
63 docs/help/html4css1.css -> docs/html4css1.css,
64 docs/help/manual.css -> docs/manual.css,
65 docs/help/manual.html -> docs/manual.html,
66 docs/help/manual.rst -> docs/manual.rst, src/ggd-plugin.c:
67 Move the manual sources from docs/help to docs since the sub-directory
68 is useless and led to some confusion.
69 Install the HTML version of the manual in DOCDIR/html rather than
70 DOCDIR.
71
72
73 2010-05-26 Colomban Wendling <ban(at)herbesfolles(dot)org>
74
75 * data/filetypes/c.conf:
76 Fix "brief" Doxygen tag in C configuration.
77
78
79 2010-05-23 Colomban Wendling <ban(at)herbesfolles(dot)org>
80
81 * Makefile.am, data/filetypes/Makefile.am, src/ggd-utils.c:
82 Temporary hackish fix for data installation.
83 * docs/help/Makefile.am, docs/help/manual.html:
84 Add the generated HTML manual under VCS for the users not to need
85 docutils.
86 * docs/help/Makefile.am:
87 Install plain-text manual together with the HTML version.
88 * data/filetypes/Makefile.am, src/ggd-utils.c:
89 Make use of the brand new PKGDATADIR.
90 * src/ggd-utils.c:
91 Don't unnecessarily prefix the paths with the directory separator since
92 they already are absolute and it brakes them on Windows (\C:\...).
93 * src/ggd-utils.c:
94 Fix error reporting in ggd_get_config_file(). Don't report an error in
95 the GError if there is actually no error, which may lead the caller not
96 to handle this correctly, or to corrupt its other uses of the passed
97 error.
98 * src/Makefile.am:
99 Set the G_LOG_DOMAIN constant to make the log message of the plugin
100 easily identifiable from those of Geany or other plugins.
101 * src/ggd-plugin.c:
102 Don't report a missing configuration file as a warning. Only print an
103 information if the configuration file is missing, since it is not a
104 problem and the file never exists at first start-up.
105
106
107 2010-05-22 Colomban Wendling <ban(at)herbesfolles(dot)org>
108
109 * src/ggd-plugin.c:
110 Fix packing of the General frame not to expand unnecessarily, which
111 would break other expansions.
112 * TODO:
113 Add an entry in the TODO-list
114 * [All]
115 Import into Geany-Plugins.
116
117
118 2010-05-21 Colomban Wendling <ban(at)herbesfolles(dot)org>
119
120 * docs/help/manual.rst:
121 Add a new section in the manual that presents and describes the UI
122 that the plugin adds to Geany.
123 * src/ggd-file-type-loader.c, src/ggd-file-type-manager.c, src/ggd-options.c,
124 src/ggd-plugin.c, src/ggd-utils.c, src/ggd-widget-doctype-selector.c,
125 src/ggd.c:
126 Strings review
127 * src/ggd-plugin.c:
128 Open the manual on plugin_help()
129 * TODO, src/Makefile.am, src/ggd-plugin.c, src/ggd-plugin.h,
130 src/ggd-widget-doctype-selector.c, src/ggd-widget-doctype-selector.h:
131 Support per-filetype documentation type setting. This is useful since
132 different languages may not share the same doctype (e.g. Java is
133 likely to use Javadoc, Vala to use Valadoc, etc.).
134
135
136 2010-05-20 Colomban Wendling <ban(at)herbesfolles(dot)org>
137
138 * TODO, src/ggd-plugin.c:
139 Use an helper function to add menu items
140
141
142 2010-05-11 Colomban Wendling <ban(at)herbesfolles(dot)org>
143
144 * src/ggd-options.c:
145 Make option saving more robust against corrupted conffile.
146 Do not fail saving if the original file cannot be loaded, simply
147 overwrite with the new settings. This fixes configuration saving when
148 the configuration file does not exist or exists but is corrupted.
149
150
151 2010-05-09 Colomban Wendling <ban(at)herbesfolles(dot)org>
152
153 * configure.ac:
154 Show whether to build documentation on configure summary
155 * docs/help/manual.rst:
156 Clarify the manual by saying for what the syntax is used
157
158
159 2010-05-04 Colomban Wendling <ban(at)herbesfolles(dot)org>
160
161 * src/Makefile.am, src/ggd-plugin.c:
162 Add a menu item to open the manual
163 * Makefile.am, README.in, configure.ac, docs/Makefile.am,
164 docs/help/Makefile.am, docs/help/html4css1.css, docs/help/manual.css,
165 docs/help/manual.rst:
166 Add a manual and install it (and other missing documentation files).
167
168
169 2010-05-01 Colomban Wendling <ban(at)herbesfolles(dot)org>
170
171 * src/ggd.c:
172 Don't use a hard-coded list of what can have arguments.
173 Always generate arguments list if the tag have one.
174 In the same spirit, always generate the "returns" symbol too even
175 when it doesn't make sense; simply let the template use it or not.
176 * src/Makefile.am, src/ggd-plugin.c, src/ggd-widget-frame.c,
177 src/ggd-widget-frame.h:
178 Implement and use Glade-style frames.
179 This makes the UI quite nicer and more consistent with both Geany
180 and GNOME.
181 * TODO:
182 Update TODO list
183 * data/filetypes/Makefile.am,
184 data/filetypes/vala.conf:
185 Add basic rules for Vala
186 * src/ggd-tag-utils.c, src/ggd-tag-utils.h,
187 src/ggd.c:
188 Fix tag scope detection for non-c-style languages.
189 Don't use hard-coded "::" separator but try to find the right
190 separator for the file type.
191 * src/ggd.c:
192 Display a message when no setting applies to a tag.
193 This eases writing/debugging of rules, and is not that intrusive for
194 production use.
195 * configure.ac, src/ggd-plugin.c:
196 Decrease plugin API dependency to 171, which should be the actual
197 version we need and should make the plugin work with Geany 0.18.1.
198 * src/ggd-plugin.c, src/ggd-plugin.h, src/ggd.c:
199 Support for global environment overrides.
200 Add a global environment to allow overrides and additions to the
201 filetype-specific environments. This is useful e.g. to set a "insert
202 since" property that will apply to all filetypes, an this without
203 modifying filetypes themselves.
204 * src/Makefile.am:
205 Fix distribution of ggd-macros.h
206 * src/ggd.c:
207 Fix crash when documenting symbol with no rules set.
208 Don't try to access the GgdDocSetting.autodoc_children field if the
209 setting is NULL (oops).
210 * src/ggd.c:
211 Fix support of argument list and return type for methods.
212 Methods was just forgotten in the list of things that can have
213 arguments and return type (oops).
214
215
216 2010-04-29 Colomban Wendling <ban(at)herbesfolles(dot)org>
217
218 * src/ggd-doc-setting.c, src/ggd-doc-setting.h, src/ggd-doc-type.c,
219 src/ggd-doc-type.h, src/ggd-file-type-loader.c, src/ggd-file-type-loader.h,
220 src/ggd-file-type-manager.c, src/ggd-file-type-manager.h,
221 src/ggd-file-type.c, src/ggd-file-type.h, src/ggd-macros.h,
222 src/ggd-options.c, src/ggd-options.h, src/ggd-plugin.c, src/ggd-plugin.h,
223 src/ggd-tag-utils.c, src/ggd-tag-utils.h, src/ggd-utils.c, src/ggd-utils.h,
224 src/ggd.c, src/ggd.h:
225 Cleanup and fix copyright information:
226 * Don't use non-ASCII character;
227 * Don't include nickname in author's name;
228 * Update some outdated dates;
229 * Add a short description of the package.
230 * src/ggd-doc-setting.h, src/ggd-doc-type.h, src/ggd-file-type-loader.h,
231 src/ggd-file-type-manager.h, src/ggd-file-type.h, src/ggd-macros.h,
232 src/ggd-options.h, src/ggd-plugin.h, src/ggd-tag-utils.h, src/ggd-utils.h,
233 src/ggd.h:
234 Set the "internal" visibility for plugin's symbols. This cleans the
235 symbol table of the plugin, as well as it might allow the compiler
236 to do some optimizations.
237
238 This is currently only supported when building with GCC >= 4.2. Builds
239 with other/older compilers will simply keep their default symbol
240 visibility.
241
242
243 2010-04-28 Colomban Wendling <ban(at)herbesfolles(dot)org>
244
245 * src/ggd-plugin.c:
246 Show the "indent" preference in the plugin's preference dialog.
247 * src/ggd-plugin.c, src/ggd-plugin.h, src/ggd.c, src/ggd.h:
248 Indent the inserted comment according to the insertion position
249 indentation. This can be disabled by a (currently) hidden "indent"
250 preference.
251 Also use editor_insert_text_block() in place of sci_insert_text(),
252 which fixes line endings to be the right ones for the working file.
253 * src/ggd-plugin.c, src/ggd-plugin.h:
254 Plugin options are now available everywhere by including ggd-plugin.h.
255 Prefix the options with GGD_ since they are now exported.
256
257
258 2010-04-26 Colomban Wendling <ban(at)herbesfolles(dot)org>
259
260 * po/fr.po:
261 Update French translation
262 * src/ggd-plugin.c:
263 Add & cleanup some tooltips.
264 Add tooltips for the tool's menu items;
265 Cleanup the big tooltip of the save-to-refresh option.
266 * data/filetypes/c.conf:
267 Use new auto-generation of children documentation
268 Use auto-generation of children's documentation for structures, unions
269 and enumerations in Doxygen format.
270 * src/ggd-doc-setting.c, src/ggd-doc-setting.h, src/ggd-file-type-loader.c,
271 src/ggd-tag-utils.c, src/ggd-tag-utils.h, src/ggd.c:
272 Support automatic documentation of children
273 Allow a rule to request for automatic generation of its children
274 documentation. This is useful for fragmented documentation styles
275 such as Doxygen not to need to manually generate documentation for
276 each children of i.e. a structure.
277
278
279 2010-04-24 Colomban Wendling <ban(at)herbesfolles(dot)org>
280
281 * data/filetypes/c.conf:
282 Use new cursor positioning in C filetype configuration
283 * src/ggd.c:
284 Add support for the special "cursor" variable in templates, allowing
285 to explicitly place the cursor in the generated comment.
286 This variable may appear more than once but currently only the first
287 occurrence that appears in the output comment is honored.
288 * data/filetypes/c.conf:
289 Update C filetype configuration
290 gtkdoc:
291 * Don't document prototypes;
292 * Fill-in union rule.
293 doxygen:
294 * Add support for more types.
295 * src/ggd.c:
296 Fix "document all" when there are symbols not to document
297 The "document all" action was aborting if the setting for any tag
298 wasn't found rather than when something went actually wrong.
299 This fixes the action when called on a file that contains symbols
300 without rules.
301
302
303 2010-04-22 Colomban Wendling <ban(at)herbesfolles(dot)org>
304
305 * TODO, src/ggd-tag-utils.c:
306 Fix ordering of tag children
307 Make ggd_tag_find_children() return a sorted list of the tags, in the
308 order they appears in the source.
309 This fixes wrong order of some children such as structure members or
310 enumeration values that were sorted alphabetically.
311 * src/ggd-doc-setting.c, src/ggd-doc-setting.h, src/ggd-file-type-loader.c,
312 src/ggd-file-type-loader.h, src/ggd-file-type-manager.c,
313 src/ggd-file-type.c, src/ggd-options.c, src/ggd-options.h,
314 src/ggd-tag-utils.c, src/ggd-tag-utils.h, src/ggd-utils.c, src/ggd-utils.h,
315 src/ggd.c:
316 Add some code documentation
317 * TODO:
318 Update TODO list
319 * data/filetypes/c.conf:
320 C configuration: fix match of empty argument list
321 Cleanly support completely empty argument lists (foo()) used e.g. in
322 macros with no arguments.
323 * data/filetypes/c.conf:
324 Updated default C filetype configuration
325 * Added template for defines;
326 * Don't include since tag by default.
327 * configure.ac:
328 Fix installation directory of plugin's data (oops)
329 Install plugin's data in ${prefix}/geany/plugin/${plugin_name} rather
330 than ${prefix}/geany/{plugin_name}.
331 If you already have installed the plugin, simply delete the old
332 directory. Sorry for this.
333
334
335 2010-04-21 Colomban Wendling <ban(at)herbesfolles(dot)org>
336
337 * src/ggd-plugin.c:
338 Make editor's menu action work at the popup position
339 When inserting documentation by activating the editor's popup menu
340 item, insert documentation for the popup position rather than for
341 the cursor's position.
342 This fixes strange behavior when using editor's popup menu item.
343 * src/ggd-plugin.c:
344 Make menu items document-sensitive when it makes sense
345 * po/fr.po:
346 Update French translation
347 * src/ggd-plugin.c:
348 Add the "Document current symbol" item to the plugin's menu too
349 * src/ggd-plugin.c, src/ggd.c, src/ggd.h:
350 Add ability to document a whole file at once
351 * src/ggd-tag-utils.c, src/ggd-tag-utils.h:
352 Add sort direction argument to ggd_tag_sort_by_line()
353 Provide a way to chose sort direction (ascending or descending) with
354 ggd_tag_sort_by_line().
355 * src/ggd-tag-utils.c, src/ggd-utils.h:
356 Move GGD_PTR_ARRAY_FOR() to ggd-utils
357
358
359 2010-04-20 Colomban Wendling <ban(at)herbesfolles(dot)org>
360
361 * src/ggd-tag-utils.c, src/ggd-tag-utils.h:
362 Make tag find functions take a const array
363 Tag find functions actually doesn't and shouldn't have to modify the
364 the given tag list they work on.
365 * src/ggd-tag-utils.c, src/ggd-tag-utils.h:
366 Add ggd_tag_sort_by_line() function that sorts a tag array by tag's
367 line.
368 * src/ggd-tag-utils.c:
369 Improve tag search for a given line
370 Make ggd_tag_find_from_line() use only a linear search rather than
371 sorting the tag array and then doing an almost linear search.
372 Benefits are probable speed improvement (array sorting isn't a cheap
373 operation) and no more modification of the given tag array.
374
375
376 2010-04-18 Colomban Wendling <ban(at)herbesfolles(dot)org>
377
378 * AUTHORS, COPYING, INSTALL, Makefile.am, README.in, TODO, autogen.sh,
379 configure.ac, data/Makefile.am, data/filetypes/Makefile.am,
380 data/filetypes/c.conf, po/LINGUAS, po/POTFILES.in, po/fr.po,
381 src/Makefile.am, src/ggd-doc-setting.c, src/ggd-doc-setting.h,
382 src/ggd-doc-type.c, src/ggd-doc-type.h, src/ggd-file-type-loader.c,
383 src/ggd-file-type-loader.h, src/ggd-file-type-manager.c,
384 src/ggd-file-type-manager.h, src/ggd-file-type.c, src/ggd-file-type.h,
385 src/ggd-options.c, src/ggd-options.h, src/ggd-plugin.c, src/ggd-plugin.h,
386 src/ggd-tag-utils.c, src/ggd-tag-utils.h, src/ggd-utils.c, src/ggd-utils.h,
387 src/ggd.c, src/ggd.h:
388 Initial commit of the plugin