summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorÁlvaro Peña <alvaropg@gmail.com>2013-10-23 23:47:29 +0200
committerÁlvaro Peña <alvaropg@gmail.com>2013-10-23 23:47:29 +0200
commit5d96b4b3275381b441642e65c926dcf91451e169 (patch)
tree9adcd8e4770bf8ff95b2eaf7dce0410a9afc552c
parentf17b00a3d6b47ef20aad796a9201bc37a9d547f2 (diff)
downloadlibgfbgraph-5d96b4b3275381b441642e65c926dcf91451e169.tar.gz
(introspection) Fixed some annotations.
-rw-r--r--gfbgraph/gfbgraph-connectable.c4
-rw-r--r--gfbgraph/gfbgraph-node.c4
-rw-r--r--gfbgraph/gfbgraph-photo.c8
-rw-r--r--gfbgraph/gfbgraph-photo.h11
-rw-r--r--gfbgraph/gfbgraph-user.c6
5 files changed, 19 insertions, 14 deletions
diff --git a/gfbgraph/gfbgraph-connectable.c b/gfbgraph/gfbgraph-connectable.c
index a1e3c2a..b125661 100644
--- a/gfbgraph/gfbgraph-connectable.c
+++ b/gfbgraph/gfbgraph-connectable.c
@@ -96,7 +96,7 @@ gfbgraph_connectable_get_connection_post_params (GFBGraphConnectable *self, GTyp
* Parse the response contained in @payload when a gfbgraph_node_get_connection_nodes() was
* executed.
*
- * Returns: (transfer full): a #GList of #GFBGraphNode created from the @payload or %NULL.
+ * Returns: (element-type GFBGraphNode) (transfer full): a newly-allocated #GList of #GFBGraphNode created from the @payload or %NULL.
**/
GList*
gfbgraph_connectable_parse_connected_data (GFBGraphConnectable *self, const gchar *payload, GError **error)
@@ -177,7 +177,7 @@ gfbgraph_connectable_get_connection_path (GFBGraphConnectable *self, GType node_
* Normally, Facebook Graph API returns the connections in the same way, using JSON objects,
* with a root object called "data".
*
- * Returns: (transfer full): a #GList of #GFBGraphNode with the same #GType as @self.
+ * Returns: (element-type GFBGraphNode) (transfer full): a newly-allocated #GList of #GFBGraphNode with the same #GType as @self.
**/
GList*
gfbgraph_connectable_default_parse_connected_data (GFBGraphConnectable *self, const gchar *payload, GError **error)
diff --git a/gfbgraph/gfbgraph-node.c b/gfbgraph/gfbgraph-node.c
index 8cf52fc..a102c02 100644
--- a/gfbgraph/gfbgraph-node.c
+++ b/gfbgraph/gfbgraph-node.c
@@ -346,7 +346,7 @@ gfbgraph_node_get_created_time (GFBGraphNode *node)
* implement the #GFBGraphConnectionable interface and be connectable to @node type object.
* See gfbgraph_node_get_connection_nodes_async() for the asynchronous version of this call.
*
- * Returns: (transfer full): a #GList of type @node_type objects with the found nodes.
+ * Returns: (element-type GFBGraphNode) (transfer full): a newly-allocated #GList of type @node_type objects with the found nodes.
**/
GList*
gfbgraph_node_get_connection_nodes (GFBGraphNode *node, GType node_type, GFBGraphAuthorizer *authorizer, GError **error)
@@ -453,7 +453,7 @@ gfbgraph_node_get_connection_nodes_async (GFBGraphNode *node, GType node_type, G
* Finishes an asynchronous operation started with
* gfbgraph_node_get_connection_nodes_async().
*
- * Returns: (transfer full): a #GList of type #node_type objects with the found nodes.
+ * Returns: (element-type GFBGraphNode) (transfer full): a newly-allocated #GList of type #node_type objects with the found nodes.
**/
GList*
gfbgraph_node_get_connection_nodes_async_finish (GFBGraphNode *node, GAsyncResult *result, GError **error)
diff --git a/gfbgraph/gfbgraph-photo.c b/gfbgraph/gfbgraph-photo.c
index b366d7b..d2f8b83 100644
--- a/gfbgraph/gfbgraph-photo.c
+++ b/gfbgraph/gfbgraph-photo.c
@@ -504,7 +504,7 @@ gfbgraph_photo_get_default_height (GFBGraphPhoto *photo)
* gfbgraph_photo_get_images:
* @photo: a #GFBGraphPhoto.
*
- * Returns: (transfer none): a #GList of #GFBGraphPhotoImage with the available photo sizes
+ * Returns: (element-type GFBGraphPhotoImage) (transfer none): a #GList of #GFBGraphPhotoImage with the available photo sizes
**/
GList*
gfbgraph_photo_get_images (GFBGraphPhoto *photo)
@@ -520,7 +520,7 @@ gfbgraph_photo_get_images (GFBGraphPhoto *photo)
*
* Returns: (transfer none): a #GFBGraphPhotoImage with the higher resolution available of the photo
**/
-GFBGraphPhotoImage*
+const GFBGraphPhotoImage*
gfbgraph_photo_get_image_hires (GFBGraphPhoto *photo)
{
g_return_val_if_fail (GFBGRAPH_IS_PHOTO (photo), NULL);
@@ -546,7 +546,7 @@ gfbgraph_photo_get_image_hires (GFBGraphPhoto *photo)
return photo->priv->hires_image;
}
-GFBGraphPhotoImage*
+const GFBGraphPhotoImage*
gfbgraph_photo_get_image_near_width (GFBGraphPhoto *photo, guint width)
{
GList *images_list;
@@ -576,7 +576,7 @@ gfbgraph_photo_get_image_near_width (GFBGraphPhoto *photo, guint width)
return photo_image;
}
-GFBGraphPhotoImage*
+const GFBGraphPhotoImage*
gfbgraph_photo_get_image_near_height (GFBGraphPhoto *photo, guint height)
{
GList *images_list;
diff --git a/gfbgraph/gfbgraph-photo.h b/gfbgraph/gfbgraph-photo.h
index 993a18b..c0d7549 100644
--- a/gfbgraph/gfbgraph-photo.h
+++ b/gfbgraph/gfbgraph-photo.h
@@ -49,6 +49,11 @@ struct _GFBGraphPhotoClass {
typedef struct _GFBGraphPhotoImage GFBGraphPhotoImage;
+/**
+ * GFBGraphPhotoImage:
+ *
+ * An struct with the information of a image.
+ */
struct _GFBGraphPhotoImage {
guint width;
guint height;
@@ -65,9 +70,9 @@ const gchar* gfbgraph_photo_get_default_source_uri (GFBGraphPhoto *photo)
guint gfbgraph_photo_get_default_width (GFBGraphPhoto *photo);
guint gfbgraph_photo_get_default_height (GFBGraphPhoto *photo);
GList* gfbgraph_photo_get_images (GFBGraphPhoto *photo);
-GFBGraphPhotoImage* gfbgraph_photo_get_image_hires (GFBGraphPhoto *photo);
-GFBGraphPhotoImage* gfbgraph_photo_get_image_near_width (GFBGraphPhoto *photo, guint width);
-GFBGraphPhotoImage* gfbgraph_photo_get_image_near_height (GFBGraphPhoto *photo, guint height);
+const GFBGraphPhotoImage* gfbgraph_photo_get_image_hires (GFBGraphPhoto *photo);
+const GFBGraphPhotoImage* gfbgraph_photo_get_image_near_width (GFBGraphPhoto *photo, guint width);
+const GFBGraphPhotoImage* gfbgraph_photo_get_image_near_height (GFBGraphPhoto *photo, guint height);
G_END_DECLS
diff --git a/gfbgraph/gfbgraph-user.c b/gfbgraph/gfbgraph-user.c
index ea53f63..eb863e5 100644
--- a/gfbgraph/gfbgraph-user.c
+++ b/gfbgraph/gfbgraph-user.c
@@ -334,7 +334,7 @@ gfbgraph_user_get_me_async_finish (GFBGraphAuthorizer *authorizer, GAsyncResult
*
* Retrieve the albums nodes owned by the @user. This functions call the function ID/albums.
*
- * Returns: (transfer full): a #GList with the albums nodes (#GFBGraphAlbums) owned by the given user.
+ * Returns: (element-type GFBGraphAlbum) (transfer full): a newly-allocated #GList with the albums nodes owned by the given user.
**/
GList*
gfbgraph_user_get_albums (GFBGraphUser *user, GFBGraphAuthorizer *authorizer, GError **error)
@@ -357,7 +357,7 @@ gfbgraph_user_get_albums (GFBGraphUser *user, GFBGraphAuthorizer *authorizer, GE
* synchronous version of this call.
*
* When the operation is finished, @callback will be called. You can then call gfbgraph_user_get_albums_async_finish()
- * to get the #GList of #GFBGraphAlbums owned by the @user.
+ * to get the #GList of #GFBGraphAlbum owned by the @user.
**/
void
gfbgraph_user_get_albums_async (GFBGraphUser *user, GFBGraphAuthorizer *authorizer, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data)
@@ -393,7 +393,7 @@ gfbgraph_user_get_albums_async (GFBGraphUser *user, GFBGraphAuthorizer *authoriz
* Finishes an asynchronous operation started with
* gfbgraph_user_get_albums_async().
*
- * Returns: (transfer full): a #GList of #GFBGraphAlbums owned by the @user.
+ * Returns: (element-type GFBGraphAlbum) (transfer full): a newly-allocated #GList of albums owned by the @user.
**/
GList*
gfbgraph_user_get_albums_async_finish (GFBGraphUser *user, GAsyncResult *result, GError **error)