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 726900 - gtk_recent_filter_filter() requirements aren't fully documented
gtk_recent_filter_filter() requirements aren't fully documented
Status: RESOLVED FIXED
Product: gtk+
Classification: Platform
Component: Documentation
3.11.x
Other Linux
: Normal normal
: ---
Assigned To: gtk-bugs
gtk-bugs
Depends on:
Blocks:
 
 
Reported: 2014-03-22 22:22 UTC by Kai Willadsen
Modified: 2014-03-24 16:41 UTC
See Also:
GNOME target: ---
GNOME version: ---

Attachments
Documentation patch (1.13 KB, patch)
2014-03-22 22:22 UTC, Kai Willadsen 		needs-work Details | Review
Updated patch (1.15 KB, patch)
2014-03-22 22:48 UTC, Kai Willadsen 		accepted-commit_now Details | Review

Description Kai Willadsen 2014-03-22 22:22:55 UTC 
Created attachment 272659 [details] [review]
Documentation patch

gtk_recent_filter_filter() requires that the GtkRecentFilterInfo structure have the requested fields set, *and* that it set the contains field to indicate which fields actually have been set. The attached patch adds a mention of this to the function documentation.
Comment 1 Emmanuele Bassi (:ebassi) 2014-03-22 22:29:49 UTC 
Review of attachment 272659 [details] [review]:

thanks for the patch.

::: gtk/gtkrecentfilter.c
@@ +697,3 @@
  * The #GtkRecentFilterInfo @filter_info should include
+ * the fields returned from gtk_recent_filter_get_needed(), and
+ * must set the @filter_info contains bit field to indicate which

this should be:

  must set the #GtkRecentFilterInfo.contains field of @filter_info to indicate which

so that it back links to the correct field of the GtkRecentFilterInfo structure (and also makes the sentence a bit more clear).
Comment 2 Kai Willadsen 2014-03-22 22:48:40 UTC 
Created attachment 272660 [details] [review]
Updated patch

Thanks. I wasn't sure what the docs syntax for referring to a struct field was. Updated patch attached.
Comment 3 Emmanuele Bassi (:ebassi) 2014-03-23 00:07:35 UTC 
Review of attachment 272660 [details] [review]:

looks good, thanks again!