From fba7408d530f5beee657e2ef85c3584dcbc23ffd Mon Sep 17 00:00:00 2001 From: Alexander Larsson Date: Thu, 28 Jan 2016 11:36:07 +0100 Subject: [PATCH] lib: Add some missing docs --- lib/xdg-app-ref.c | 10 ++++++++++ lib/xdg-app-remote.c | 20 ++++++++++++++++++++ 2 files changed, 30 insertions(+) diff --git a/lib/xdg-app-ref.c b/lib/xdg-app-ref.c index b0573489..584a923a 100644 --- a/lib/xdg-app-ref.c +++ b/lib/xdg-app-ref.c @@ -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) { diff --git a/lib/xdg-app-remote.c b/lib/xdg-app-remote.c index 8d45a785..4de191d4 100644 --- a/lib/xdg-app-remote.c +++ b/lib/xdg-app-remote.c @@ -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)