luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-01-13 07:56:17 +01:00
Code Issues Packages Projects Releases Wiki Activity

Doc improvement

Browse Source 
svn path=/trunk/; revision=7173
This commit is contained in:
Matthias Clasen 2008-07-09 04:26:47 +00:00
parent 07d4c14f8d
commit 0a20d4cbe4
3 changed files with 18 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
gio/ChangeLog
View File

@ -1,5 +1,7 @@
2008-07-08 Matthias Clasen <mclasen@redhat.com>
* gvolumemonitor.c:
* gfile.c:
* gvolume.c:
* gmount.c: Documentation improvements.

22
gio/gfile.c
View File

@ -604,6 +604,7 @@ g_file_equal (GFile *file1,
*
* Returns: a #GFile structure to the parent of the given
* #GFile or %NULL if there is no parent.
* Free the returned object with g_object_unref().
**/
GFile *
g_file_get_parent (GFile *file)
@ -631,6 +632,7 @@ g_file_get_parent (GFile *file)
* This call does no blocking i/o.
*
* Returns: a #GFile to a child specified by @name.
* Free the returned object with g_object_unref().
**/
GFile *
g_file_get_child (GFile *file,
@ -658,6 +660,7 @@ g_file_get_child (GFile *file,
*
* Returns: a #GFile to the specified child, or
* %NULL if the display name couldn't be converted.
* Free the returned object with g_object_unref().
**/
GFile *
g_file_get_child_for_display_name (GFile *file,
@ -679,14 +682,16 @@ g_file_get_child_for_display_name (GFile *file,
* @file: input #GFile.
* @prefix: input #GFile.
*
* Checks whether @file has the prefix specified by @prefix. In other word, if the
* names of inital elements of @file<!-- -->s pathname match @prefix.
* Checks whether @file has the prefix specified by @prefix. In other word,
* if the names of inital elements of @file<!-- -->s pathname match @prefix.
*
* This call does no i/o, as it works purely on names. As such it can sometimes
* return %FALSE even if @file is inside a @prefix (from a filesystem point of view),
* because the prefix of @file is an alias of @prefix.
* This call does no i/o, as it works purely on names. As such it can
* sometimes return %FALSE even if @file is inside a @prefix (from a
* filesystem point of view), because the prefix of @file is an alias
* of @prefix.
*
* Returns: %TRUE if the @files's parent, grandparent, etc is @prefix. %FALSE otherwise.
* Returns: %TRUE if the @files's parent, grandparent, etc is @prefix.
* %FALSE otherwise.
**/
gboolean
g_file_has_prefix (GFile *file,
@ -717,8 +722,8 @@ g_file_has_prefix (GFile *file,
* This call does no blocking i/o.
*
* Returns: string with the relative path from @descendant
* to @parent, or %NULL if @descendant doesn't have @parent as prefix. The returned string should be freed with
* g_free() when no longer needed.
* to @parent, or %NULL if @descendant doesn't have @parent as prefix.
* The returned string should be freed with g_free() when no longer needed.
**/
char *
g_file_get_relative_path (GFile *parent,
@ -748,6 +753,7 @@ g_file_get_relative_path (GFile *parent,
*
* Returns: #GFile to the resolved path. %NULL if @relative_path
* is %NULL or if @file is invalid.
* Free the returned object with g_object_unref().
**/
GFile *
g_file_resolve_relative_path (GFile *file,

2
gio/gvolumemonitor.c
View File

@ -332,6 +332,7 @@ g_volume_monitor_get_mounts (GVolumeMonitor *volume_monitor)
* Finds a #GVolume object by it's UUID (see g_volume_get_uuid())
*
* Returns: a #GVolume or %NULL if no such volume is available.
* Free the returned object with g_object_unref().
**/
GVolume *
g_volume_monitor_get_volume_for_uuid (GVolumeMonitor *volume_monitor,
@ -355,6 +356,7 @@ g_volume_monitor_get_volume_for_uuid (GVolumeMonitor *volume_monitor,
* Finds a #GMount object by it's UUID (see g_mount_get_uuid())
*
* Returns: a #GMount or %NULL if no such mount is available.
* Free the returned object with g_object_unref().
**/
GMount *
g_volume_monitor_get_mount_for_uuid (GVolumeMonitor *volume_monitor,