lib: Add some missing docs

tingping/wmclass
Alexander Larsson 2016-01-28 11:36:07 +01:00
parent 68c0e04adc
commit fba7408d53
2 changed files with 30 additions and 0 deletions

View File

@ -249,6 +249,16 @@ xdg_app_ref_format_ref (XdgAppRef *self)
priv->arch);
}
/**
* xdg_app_ref_parse
* @ref: A string ref name, such as "app/org.test.App/86_64/master"
* @error: return location for a #GError
*
* Tries to parse a full ref name and return a #XdgAppRef (without a
* commit set) or fail if the ref is invalid somehow.
*
* Returns: (transfer full): an #XdgAppRef
*/
XdgAppRef *
xdg_app_ref_parse (const char *ref, GError **error)
{

View File

@ -129,6 +129,16 @@ xdg_app_remote_get_name (XdgAppRemote *self)
return priv->name;
}
/**
* xdg_app_remote_get_appstream_dir
* @self: a #XdgAppRemote
* @arch: (nullable): which architecture to fetch (default: current architecture)
*
* Returns the directory where this remote will store locally cached
* appstream information for the specified @arch.
*
* Returns: (transfer full): an #GFile
**/
GFile *
xdg_app_remote_get_appstream_dir (XdgAppRemote *self,
const char *arch)
@ -145,6 +155,16 @@ xdg_app_remote_get_appstream_dir (XdgAppRemote *self,
subdir);
}
/**
* xdg_app_remote_get_appstream_timestamp
* @self: a #XdgAppRemote
* @arch: (nullable): which architecture to fetch (default: current architecture)
*
* Returns the timestamp file that will be updated whenever the appstream information
* has been updated (or tried to update) for the specified @arch.
*
* Returns: (transfer full): an #GFile
**/
GFile *
xdg_app_remote_get_appstream_timestamp (XdgAppRemote *self,
const char *arch)