GNOME Bugzilla – Bug 771255
"Symbol name not found at the start of comment block" warning with "attributes" annotation.
Last modified: 2016-09-19 14:06:42 UTC
"Symbol name not found at the start of comment block" warning is thrown on the symbols with "attributes" annotation. If the annotation contains only name, warning is not thrown. One below is an example of this. > /** > * OnggiModuleObject: (attributes onggi.tracked=true onggi.table.name=_onggi_mo) > * > * OnggiModuleObject structure contains private fields. > */ g-ir-scanner does not have problem to read this.
(In reply to Lim Jongrok from comment #0) */ > > g-ir-scanner does not have problem to read this. Not too surprising, given that g-i continues to embrace and extend the gtk-doc doc comment format.
What do you mean by "If the annotation contains only name, warning is not thrown". can you add an example that works. FYI: this is the supported format: https://wiki.gnome.org/Projects/GObjectIntrospection/Annotations#Attributes So, if the g-i project changed it, they forgot to update the docs and send a gtk-doc patch (or at least give the gtk-doc project a a heads up). Not to mention that a cc on the discussion would have been nice. Lim, do you have any evidence that this format is official?
Lim, just checked, it is the '=' part that is not part of the spec. So please double check on that. FYI: the gtk-doc implementation is part of gtkdoc-mkdb.in.
But, the page also says about '=' in the annotation. https://wiki.gnome.org/Projects/GObjectIntrospection/Annotations#Data_annotations (Both of two quotation are from the page.) > (attributes my.key=val my.key2) > Attributes are free-form "key=value" annotations. When present, at least one key has to be specified. Assigning values to keys is optional. And, I mean it by "If the annotation contains only name, warning is not thrown.", that "(attributes onggi.tracked)" does not results in any warning.
commit 4512111ad115e3b125818dba6249cc8329d72d3f Author: Stefan Sauer <ensonic@users.sf.net> Date: Mon Sep 19 16:05:01 2016 +0200 annotations: allow '=' to be used in annotations The online docs seem to have added a key=value form. Fixes #771255