gfile: Clarify g_file_get_parent() documentation

Clarify that a parent in this case has to be an immediate parent, not an
arbitrary ancestor several levels up in the tree.
This commit is contained in:
Philip Withnall
2015-08-24 10:38:27 +01:00
parent 50a65cc38a
commit 76c1f78cb9

View File

@@ -714,10 +714,10 @@ g_file_get_parent (GFile *file)
* *
* If @parent is %NULL then this function returns %TRUE if @file has any * If @parent is %NULL then this function returns %TRUE if @file has any
* parent at all. If @parent is non-%NULL then %TRUE is only returned * parent at all. If @parent is non-%NULL then %TRUE is only returned
* if @file is a child of @parent. * if @file is an immediate child of @parent.
* *
* Returns: %TRUE if @file is a child of @parent (or any parent in the * Returns: %TRUE if @file is an immediate child of @parent (or any parent in
* case that @parent is %NULL). * the case that @parent is %NULL).
* *
* Since: 2.24 * Since: 2.24
*/ */