GNOME Bugzilla – Bug 784182
Change how code snippets are marked in developer comments
Last modified: 2017-06-26 12:17:20 UTC
It seems that gtk-doc tools no longer allow using < and > directly in <programlisting> after gtk-doc is rewritten in python. ../xml/e-extensible.xml:50: parser error : error parsing attribute name #include <libedataserver/libedataserver.h> ^ ../xml/e-extensible.xml:50: parser error : attributes construct error #include <libedataserver/libedataserver.h> ^ ../xml/e-extensible.xml:50: parser error : Couldn't find end of Start Tag libedataserver line 50 #include <libedataserver/libedataserver.h> ^ ../evolution-data-server-docs.sgml:163: element include: XInclude error : could not load ../xml/e-extensible.xml, and no fallback was found This problem has been reported to gtk-doc as bug 783420, and they recommend using CDATA sections or |[ and ]|.
Created attachment 354420 [details] [review] docs: Use short notation to avoid XML error caused by example code
Thanks for a bug report and patch. I see the 1.25 release is fine, it;'s the git master which is broken. I noticed two regressions from 1.25 when testing, which I filled as bug #784208 and bug #784209. I searched the evolution-data-server code and I noticed that the documentation is inconsistent in the code mark-ups, thus I extended your fix and made it consistent around the code (not so many places). It's better, especially when someone would like to copy that elsewhere, thus not using outdated form of the mark up. I'm committing this only to master, because it depends on an unreleased version of gtk-doc. I verified that at least gtk-doc 1.25 understands the new mark up notation, but I still do not see much gain in changing this in the stable branch as well at the moment. Created commit e57f8cc in eds master (3.25.4+)