After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 730777 - Add support for nullable and optional annotations
Add support for nullable and optional annotations
Status: RESOLVED FIXED
Product: gtk-doc
Classification: Platform
Component: general
unspecified
Other Linux
: Normal normal
: 1.21
Assigned To: gtk-doc maintainers
gtk-doc maintainers
: 731379 (view as bug list)
Depends on:
Blocks:
 
 
Reported: 2014-05-27 00:17 UTC by Evan Nemerson
Modified: 2014-06-23 11:44 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Add support for new nullable and optional annotations. (3.33 KB, patch)
2014-05-27 00:17 UTC, Evan Nemerson
none Details | Review
gtkdoc-mkdb: Add support for (nullable) and (optional) annotations (5.28 KB, patch)
2014-06-23 10:48 UTC, Philip Withnall
none Details | Review
gtkdoc-mkdb: Add support for (nullable) and (optional) annotations (5.36 KB, patch)
2014-06-23 11:43 UTC, Philip Withnall
committed Details | Review

Description Evan Nemerson 2014-05-27 00:17:46 UTC
Created attachment 277247 [details] [review]
Add support for new nullable and optional annotations.

The nullable and optional annotations replace allow-none.  See
https://bugzilla.gnome.org/show_bug.cgi?id=660879 for details.
Comment 1 Philip Withnall 2014-06-23 10:47:59 UTC
*** Bug 731379 has been marked as a duplicate of this bug. ***
Comment 2 Philip Withnall 2014-06-23 10:48:18 UTC
Created attachment 278984 [details] [review]
gtkdoc-mkdb: Add support for (nullable) and (optional) annotations

These deprecate and replace (allow-none), which was ill-defined for
(out) parameters.

This includes some updated unit tests.
Comment 3 Philip Withnall 2014-06-23 10:49:18 UTC
I should have checked if a bug existed before I went ahead and wrote a patch. :-(  Attaching my patch here because it contains a few more test cases than Evan’s, although they are otherwise equivalent. His wording for the annotations may be clearer than mine.
Comment 4 Stefan Sauer (gstreamer, gtkdoc dev) 2014-06-23 11:40:46 UTC
Comment on attachment 278984 [details] [review]
gtkdoc-mkdb: Add support for (nullable) and (optional) annotations

Can you take the description for 'optional' from the other patch. Then please submit yours.
Comment 5 Philip Withnall 2014-06-23 11:43:03 UTC
Created attachment 278991 [details] [review]
gtkdoc-mkdb: Add support for (nullable) and (optional) annotations

These deprecate and replace (allow-none), which was ill-defined for
(out) parameters.

This includes some updated unit tests.

Including a wording contribution from Evan Nemerson
<evan@coeus-group.com>.
Comment 6 Philip Withnall 2014-06-23 11:43:38 UTC
Merged with the wording change. Thanks for the review!

Attachment 278991 [details] pushed as 36b2f2b - gtkdoc-mkdb: Add support for (nullable) and (optional) annotations