GNOME Bugzilla – Bug 774168
gobject introspection annotations and gtk-doc parser do not agree
Last modified: 2016-11-11 08:24:07 UTC
I just noticed that the annotations for gobject introspection do not agree with the gtk-doc parser. Specifically with a #define comment: /** * E_NETWORK_MONITOR_ALWAYS_ONLINE_NAME: (value "always-online") * * A special name, which can be used as a GIO name in the call * to e_network_monitor_set_gio_name(), which is used to report * the the network as always reachable. * * Since: 3.22 **/ #define E_NETWORK_MONITOR_ALWAYS_ONLINE_NAME "always-online" it results in a warning: > ..../src/libedataserver/e-network-monitor.h:59: warning: Symbol name not > found at the start of the comment block. This is a no-win state for me, because I'd like to cover all (or at least most of) the gtk-doc and gobject-introspection warnings (thus it'll be easier to catch new issues during compile time), but I cannot reach it due to this issue. It might be relatively easy to fix on the gtk-doc side, maybe? This is with gtk-doc-1.25-1.fc25.x86_64.
Meh, the docs never stated what can be in value and gtk-doc does not accept quotes. If I change that someone will add a string that contains a ')' and it will fall apart again :/ I'll add the quotes now, but imho the value annotation is underspecified.
commit bc5d2bce65cbda332d45625c9f8ec147522f78a7 Author: Stefan Sauer <ensonic@users.sf.net> Date: Thu Nov 10 21:16:45 2016 +0100 gtkdoc-mkdb: accept every char in an annotation It is unlikely that this format ever gets a formal specification. Hopefully has no sideeffects. Fixes https://bugzilla.gnome.org/show_bug.cgi?id=774168
Thanks. I guess the value is quoted, because it's a string. But my knowledge on the introspection annotation is very limited.