upcoming gtk-doc-1.21 wont support freeform returns docs.
- From: Stefan Sauer <ensonic hora-obscura de>
- To: desktop-devel-list <desktop-devel-list gnome org>, gtk-doc-list gnome org
- Subject: upcoming gtk-doc-1.21 wont support freeform returns docs.
- Date: Thu, 10 Jul 2014 10:10:49 +0200
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
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]