Weirdly enough, if the HTML (or possibly LATEX?) output is not generated, Doxygen incorrectly warns about all parameters and return values not being documented.
Workaround this by disabling undocumented warnings when generating GI which only produces XML, and thus triggers the bug.
See https://stackoverflow.com/a/38745256 You can view, comment on, or merge this pull request online at:
https://github.com/geany/geany/pull/4242
-- Commit Summary --
* Silence spurious undocumented warnings when generating GI
-- File Changes --
M doc/Doxyfile.in (4) M doc/Makefile.am (2) M doc/meson.build (2)
-- Patch Links --
https://github.com/geany/geany/pull/4242.patch https://github.com/geany/geany/pull/4242.diff
techee left a comment (geany/geany#4242)
Nice, I was "fixing" this problem by uninstalling doxygen ;-)
I'm still getting the warnings below. It's because I just referred to other similar functions using `@see` in the documentation. Should I do anything about those?
``` /home/parallels/projects/geany/src/pluginextension.c:234: warning: parameters of member plugin_extension_calltips_provided are not documented /home/parallels/projects/geany/src/pluginextension.c:234: warning: return type of member plugin_extension_calltips_provided is not documented /home/parallels/projects/geany/src/pluginextension.c:255: warning: parameters of member plugin_extension_goto_provided are not documented /home/parallels/projects/geany/src/pluginextension.c:255: warning: return type of member plugin_extension_goto_provided is not documented /home/parallels/projects/geany/src/pluginextension.c:276: warning: parameters of member plugin_extension_symbol_highlight_provided are not documented /home/parallels/projects/geany/src/pluginextension.c:276: warning: return type of member plugin_extension_symbol_highlight_provided is not documented /home/parallels/projects/geany/src/symbols.c:264: warning: return type of member symbols_get_icon_pixbuf is not documented ```
b4n left a comment (geany/geany#4242)
I'm still getting the warnings below. It's because I just referred to other similar functions using `@see` in the documentation. Should I do anything about those?
The last one I shamelessly fixed without a PR in 528b1a25263124dfc3021d6bb40c0f52179cc57e.
The rest… well, ideally yes, if you can come up with a wording that don't make this super heavy, yet has some usefulness to it. I'd rather have no warnings here at all so it doesn't hide others, and I don't waste time every few years looking at them and wondering how to deal with them :) Admittedly we'll have a whole lot more now, and it's actually possible to fix the remaining ones -- which is better than frantically modifying the existing documentation and wonder why the heck it doesn't change anything.
PS: I still wonder why some enumerations (like TMIcon) are missing from the docs… @eht16, any clue?
techee left a comment (geany/geany#4242)
The rest… well, ideally yes, if you can come up with a wording that don't make this super heavy, yet has some usefulness to it.
Done in #4247. Not sure about usefulness as it repeats the same thing again and again but probably better than the warnings.
Merged #4242 into master.
github-comments@lists.geany.org