docs: Document gtk_recent_filter_filter() requirements

gtk_recent_filter_filter() needs the contains bitfield to be set, but
this only mentions that the other fields are required.

https://bugzilla.gnome.org/show_bug.cgi?id=726900
This commit is contained in:
Kai Willadsen 2014-03-23 08:12:09 +10:00 committed by Matthias Clasen
parent 21687bcedb
commit baf4678087

View File

@ -695,7 +695,9 @@ gtk_recent_filter_add_custom (GtkRecentFilter *filter,
*
* Tests whether a file should be displayed according to @filter.
* The #GtkRecentFilterInfo @filter_info should include
* the fields returned from gtk_recent_filter_get_needed().
* the fields returned from gtk_recent_filter_get_needed(), and
* must set the #GtkRecentFilterInfo.contains field of @filter_info
* to indicate which fields have been set.
*
* This function will not typically be used by applications; it
* is intended principally for use in the implementation of