mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2024-11-10 03:16:17 +01:00
Documentation updates
svn path=/trunk/; revision=6138
This commit is contained in:
Matthias Clasen
parent
f87b822b21
commit
2e3f48993d
@ -1,3 +1,13 @@
|
||||
2007-12-17 Matthias Clasen <mclasen@redhat.com>
|
||||
|
||||
* gdesktopappinfo.c:
|
||||
* gunixmounts.c:
|
||||
* gfileinfo.c:
|
||||
* gvolumemonitor.c:
|
||||
* gfile.h:
|
||||
* gioscheduler.c:
|
||||
* gvolume.h: Documentation updates
|
||||
|
||||
2007-12-14 Matthias Clasen <mclasen@redhat.com>
|
||||
|
||||
* gunixmounts.c:
|
||||
|
||||
@ -148,6 +148,8 @@ g_desktop_app_info_init (GDesktopAppInfo *local)
|
||||
* g_desktop_app_info_new_from_filename:
|
||||
* @filename: a string containing a file name.
|
||||
*
|
||||
* Creates a new #GDesktopAppInfo.
|
||||
*
|
||||
* Returns: a new #GDesktopAppInfo or %NULL on error.
|
||||
**/
|
||||
GDesktopAppInfo *
|
||||
@ -254,6 +256,8 @@ g_desktop_app_info_new_from_filename (const char *filename)
|
||||
* g_desktop_app_info_new:
|
||||
* @desktop_id: the desktop file id
|
||||
*
|
||||
* Creates a new #GDesktopAppInfo.
|
||||
*
|
||||
* Returns: a new #GDesktopAppInfo, or %NULL if no desktop file with that id
|
||||
**/
|
||||
GDesktopAppInfo *
|
||||
|
||||
@ -43,6 +43,7 @@ G_BEGIN_DECLS
|
||||
|
||||
/**
|
||||
* GFileQueryInfoFlags:
|
||||
* @G_FILE_QUERY_INFO_NONE: No flags set.
|
||||
* @G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS: Don't follow symlinks.
|
||||
*
|
||||
* Flags used when querying a #GFileInfo.
|
||||
|
||||
@ -871,10 +871,10 @@ g_file_info_create_value_by_name (GFileInfo *info,
|
||||
* g_file_info_set_attribute:
|
||||
* @info: a #GFileInfo.
|
||||
* @attribute: a file attribute key.
|
||||
* @attr_value: a #GFileAttributeValue.
|
||||
* @type: a #GFileAttributeType
|
||||
* @value_p: pointer to the value
|
||||
*
|
||||
* Sets the @attribute to contain the given @attr_value,
|
||||
* if possible.
|
||||
* Sets the @attribute to contain the given value, if possible.
|
||||
**/
|
||||
void
|
||||
g_file_info_set_attribute (GFileInfo *info,
|
||||
|
||||
@ -324,16 +324,17 @@ mainloop_proxy_free (MainLoopProxy *proxy)
|
||||
* @user_data: a #gpointer.
|
||||
* @notify: a #GDestroyNotify.
|
||||
*
|
||||
* Used from an I/O job to send a callback to be run in the main loop (main thread), waiting for
|
||||
* the result (and thus blocking the I/O job).
|
||||
* Used from an I/O job to send a callback to be run in the
|
||||
* main loop (main thread), waiting for the result (and thus
|
||||
* blocking the I/O job).
|
||||
*
|
||||
* Returns: The return value of @func
|
||||
**/
|
||||
gboolean
|
||||
g_io_scheduler_job_send_to_mainloop (GIOSchedulerJob *job,
|
||||
GSourceFunc func,
|
||||
gpointer user_data,
|
||||
GDestroyNotify notify)
|
||||
GSourceFunc func,
|
||||
gpointer user_data,
|
||||
GDestroyNotify notify)
|
||||
{
|
||||
GSource *source;
|
||||
MainLoopProxy *proxy;
|
||||
@ -380,21 +381,22 @@ g_io_scheduler_job_send_to_mainloop (GIOSchedulerJob *job,
|
||||
}
|
||||
|
||||
/**
|
||||
* g_io_scheduler_job_send_to_mainloop:
|
||||
* g_io_scheduler_job_send_to_mainloop_async:
|
||||
* @job: a #GIOSchedulerJob.
|
||||
* @func: a #GSourceFunc callback that will be called in the main thread.
|
||||
* @user_data: a #gpointer.
|
||||
* @notify: a #GDestroyNotify.
|
||||
*
|
||||
* Used from an I/O job to send a callback to be run asynchronously in the main loop (main thread).
|
||||
* The callback will be run when the main loop is availible, but at that time the I/O job
|
||||
* might have finished. The return value from the callback is ignored.
|
||||
* Used from an I/O job to send a callback to be run asynchronously
|
||||
* in the main loop (main thread). The callback will be run when the
|
||||
* main loop is available, but at that time the I/O job might have
|
||||
* finished. The return value from the callback is ignored.
|
||||
**/
|
||||
void
|
||||
g_io_scheduler_job_send_to_mainloop_async (GIOSchedulerJob *job,
|
||||
GSourceFunc func,
|
||||
gpointer user_data,
|
||||
GDestroyNotify notify)
|
||||
GSourceFunc func,
|
||||
gpointer user_data,
|
||||
GDestroyNotify notify)
|
||||
{
|
||||
GSource *source;
|
||||
MainLoopProxy *proxy;
|
||||
|
||||
@ -1650,8 +1650,9 @@ g_unix_mount_guess_type (GUnixMountEntry *mount_entry)
|
||||
* g_unix_mount_point_guess_type:
|
||||
* @mount_point: a #GUnixMountPoint.
|
||||
*
|
||||
* Guesses the type of a unix mount point. If the mount type cannot be
|
||||
* determined, returns %G_UNIX_MOUNT_TYPE_UNKNOWN.
|
||||
* Guesses the type of a unix mount point.
|
||||
* If the mount type cannot be determined,
|
||||
* returns %G_UNIX_MOUNT_TYPE_UNKNOWN.
|
||||
*
|
||||
* Returns: a #GUnixMountType.
|
||||
**/
|
||||
@ -1732,6 +1733,16 @@ type_to_icon (GUnixMountType type, gboolean is_mount_point)
|
||||
return icon_name;
|
||||
}
|
||||
|
||||
/**
|
||||
* g_unix_mount_guess_name:
|
||||
* @mount_entry: a #GUnixMountEntry
|
||||
*
|
||||
* Guesses the name of a Unix mount.
|
||||
* The result is a translated string.
|
||||
*
|
||||
* Returns: A newly allocated string that must
|
||||
* be freed with g_free()
|
||||
*/
|
||||
char *
|
||||
g_unix_mount_guess_name (GUnixMountEntry *mount_entry)
|
||||
{
|
||||
@ -1745,12 +1756,30 @@ g_unix_mount_guess_name (GUnixMountEntry *mount_entry)
|
||||
return name;
|
||||
}
|
||||
|
||||
/**
|
||||
* g_unix_mount_guess_icon:
|
||||
* @mount_entry: a #GUnixMountEntry
|
||||
*
|
||||
* Guesses the icon of a Unix mount.
|
||||
*
|
||||
* Returns: a #GIcon
|
||||
*/
|
||||
GIcon *
|
||||
g_unix_mount_guess_icon (GUnixMountEntry *mount_entry)
|
||||
{
|
||||
return g_themed_icon_new (type_to_icon (g_unix_mount_guess_type (mount_entry), FALSE));
|
||||
}
|
||||
|
||||
/**
|
||||
* g_unix_mount_point_guess_name:
|
||||
* @mount_point: a #GUnixMountPoint
|
||||
*
|
||||
* Guesses the name of a Unix mount point.
|
||||
* The result is a translated string.
|
||||
*
|
||||
* Returns: A newly allocated string that must
|
||||
* be freed with g_free()
|
||||
*/
|
||||
char *
|
||||
g_unix_mount_point_guess_name (GUnixMountPoint *mount_point)
|
||||
{
|
||||
@ -1764,6 +1793,14 @@ g_unix_mount_point_guess_name (GUnixMountPoint *mount_point)
|
||||
return name;
|
||||
}
|
||||
|
||||
/**
|
||||
* g_unix_mount_point_guess_icon:
|
||||
* @mount_point: a #GUnixMountPoint
|
||||
*
|
||||
* Guesses the icon of a Unix mount point.
|
||||
*
|
||||
* Returns: a #GIcon
|
||||
*/
|
||||
GIcon *
|
||||
g_unix_mount_point_guess_icon (GUnixMountPoint *mount_point)
|
||||
{
|
||||
|
||||
@ -48,7 +48,7 @@ G_BEGIN_DECLS
|
||||
* @get_drive: Gets a #GDrive the volume is located on. Returns %NULL if the #GVolume is not associated with a #GDrive.
|
||||
* @get_mount: Gets a #GMount representing the mounted volume. Returns %NULL if the #GVolume is not mounted.
|
||||
* @can_mount: Returns %TRUE if the #GVolume can be mounted.
|
||||
* @mount: Mounts a given #GVolume.
|
||||
* @mount_fn: Mounts a given #GVolume.
|
||||
* @mount_finish: Finishes a mount operation.
|
||||
*
|
||||
* Interface for implementing operations for mountable volumes.
|
||||
|
||||
@ -231,7 +231,7 @@ g_volume_monitor_init (GVolumeMonitor *monitor)
|
||||
|
||||
|
||||
/**
|
||||
* g_volume_monitor_get_drives:
|
||||
* g_volume_monitor_get_connected_drives:
|
||||
* @volume_monitor: a #GVolumeMonitor.
|
||||
*
|
||||
* Gets a list of drives connected to the system.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user