Commit e2ba37ce authored by Matthias Clasen's avatar Matthias Clasen

Document new api

svn path=/trunk/; revision=6397
parent 76b565e8
2008-01-28 Matthias Clasen <mclasen@redhat.com> 2008-01-28 Matthias Clasen <mclasen@redhat.com>
* gvolume.[hc]: Document new API.
* gfile.c (g_file_copy_async): Fix docs * gfile.c (g_file_copy_async): Fix docs
......
...@@ -420,9 +420,20 @@ g_volume_eject_finish (GVolume *volume, ...@@ -420,9 +420,20 @@ g_volume_eject_finish (GVolume *volume,
return (* iface->eject_finish) (volume, result, error); return (* iface->eject_finish) (volume, result, error);
} }
/**
* g_volume_get_identifier:
* @volume: a #GVolume
* @kind: the kind of identifier to return
*
* Gets the identifier of the given kind for @volume.
*
* Returns: a newly allocated string containing the
* requested identfier, or %NULL if the #GVolume
* doesn't have this kind of identifier
*/
char * char *
g_volume_get_identifier (GVolume *volume, g_volume_get_identifier (GVolume *volume,
const char *kind) const char *kind)
{ {
GVolumeIface *iface; GVolumeIface *iface;
...@@ -437,6 +448,17 @@ g_volume_get_identifier (GVolume *volume, ...@@ -437,6 +448,17 @@ g_volume_get_identifier (GVolume *volume,
return (* iface->get_identifier) (volume, kind); return (* iface->get_identifier) (volume, kind);
} }
/**
* g_volume_enumerate_identifiers:
* @volume: a #GVolume
*
* Gets the kinds of identifiers that @volume has.
* Use g_volume_get_identifer() to obtain the identifiers
* themselves.
*
* Returns: a %NULL-terminated array of strings containing
* kinds of identifiers. Use g_strfreev() to free.
*/
char ** char **
g_volume_enumerate_identifiers (GVolume *volume) g_volume_enumerate_identifiers (GVolume *volume)
{ {
......
...@@ -62,6 +62,10 @@ G_BEGIN_DECLS ...@@ -62,6 +62,10 @@ G_BEGIN_DECLS
* @mount_finish: Finishes a mount operation. * @mount_finish: Finishes a mount operation.
* @eject: Ejects a given #GVolume. * @eject: Ejects a given #GVolume.
* @eject_finish: Finishes an eject operation. * @eject_finish: Finishes an eject operation.
* @get_identifier: Returns the identifier of the given kind, or %NULL if
* the #GVolume doesn't have one.
* @enumerate_identifiers: Returns an array strings listing the kinds
* of identifiers which the #GVolume has.
* *
* Interface for implementing operations for mountable volumes. * Interface for implementing operations for mountable volumes.
**/ **/
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment