[gnome-pocket] Add API docs for a couple of GnomePocket functions



commit b726dc535c0587013a9d81d7b38802b559705466
Author: Bastien Nocera <hadess hadess net>
Date:   Sat Sep 20 19:57:44 2014 +0200

    Add API docs for a couple of GnomePocket functions

 gnome-pocket/gnome-pocket.c |   17 +++++++++++++++++
 1 files changed, 17 insertions(+), 0 deletions(-)
---
diff --git a/gnome-pocket/gnome-pocket.c b/gnome-pocket/gnome-pocket.c
index f27c30c..08074d3 100644
--- a/gnome-pocket/gnome-pocket.c
+++ b/gnome-pocket/gnome-pocket.c
@@ -611,6 +611,16 @@ gnome_pocket_load_cached_finish (GnomePocket         *self,
   return g_task_propagate_boolean (task, error);
 }
 
+/**
+ * gnome_pocket_get_items:
+ * @self: a #GnomePocket
+ *
+ * Gets the items that Pocket knows about.
+ *
+ * Returns: (element-type GnomePocketItem) (transfer none): A list of
+ * items or %NULL. Do not modify or free the list, it belongs to the
+ * #GnomePocket object.
+ **/
 GList *
 gnome_pocket_get_items (GnomePocket *self)
 {
@@ -906,6 +916,13 @@ gnome_pocket_init (GnomePocket *self)
                   (GAsyncReadyCallback) client_ready_cb, self);
 }
 
+/**
+ * gnome_pocket_new:
+ *
+ * Creates a new #GnomePocket object.
+ *
+ * Returns: (transfer full): a new #GnomePocket object. Use g_object_unref() when done.
+ **/
 GnomePocket *
 gnome_pocket_new (void)
 {


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]