upcoming gtk-doc-1.21 wont support freeform returns docs.

classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
|

upcoming gtk-doc-1.21 wont support freeform returns docs.

Stefan Sauer-4
hi,

TL;DR https://bugzilla.gnome.org/show_bug.cgi?id=678094

So far gtk-doc included a heuristic that accepted the last paragraph of
a body doc-blob as return documentation if it started with "Return(s)".
As this can be ambiguous with a desired "Returns: " block, we added a
warning for the cases the heuristic kicked in many years ago. I just
pushed a change to drop the heuristics.

If you now build your docs using gtk-doc HEAD and get entries in
$(DOC_MODULE)-undocumented.txt, check the symbols and convert them into
proper Returns: sections.

Let me know if there are any issues.

Stefan
_______________________________________________
gtk-doc-list mailing list
[hidden email]
https://mail.gnome.org/mailman/listinfo/gtk-doc-list