From d06cb3dabbd7fbb87cb2763e69bce9ac782450eb Mon Sep 17 00:00:00 2001 From: Cosimo Cecchi Date: Mon, 7 Jan 2013 07:49:23 +0100 Subject: libdocument: add missing transfer and element-type annotations https://bugzilla.gnome.org/show_bug.cgi?id=691354 origin commit: https://git.gnome.org/browse/evince/commit/?h=gnome-3-8&id=7917b62 --- libdocument/ev-document-attachments.c | 6 ++++++ libdocument/ev-document-find.c | 9 +++++++++ libdocument/ev-document-images.c | 7 +++++++ libdocument/ev-document-layers.c | 6 ++++++ libdocument/ev-document-links.c | 13 +++++++++++++ libdocument/ev-document-misc.c | 22 ++++++++++++++++++++++ libdocument/ev-document-transition.c | 7 +++++++ 7 files changed, 70 insertions(+) (limited to 'libdocument') diff --git a/libdocument/ev-document-attachments.c b/libdocument/ev-document-attachments.c index 3c59375e..6b1b695f 100644 --- a/libdocument/ev-document-attachments.c +++ b/libdocument/ev-document-attachments.c @@ -38,6 +38,12 @@ ev_document_attachments_has_attachments (EvDocumentAttachments *document_attachm return iface->has_attachments (document_attachments); } +/** + * ev_document_attachments_get_attachments: + * @document_attachments: an #EvDocumentAttachments + * + * Returns: (transfer full) (element-type EvAttachment): a list of #EvAttachment objects + */ GList * ev_document_attachments_get_attachments (EvDocumentAttachments *document_attachments) { diff --git a/libdocument/ev-document-find.c b/libdocument/ev-document-find.c index 92dfffe5..4be1b201 100644 --- a/libdocument/ev-document-find.c +++ b/libdocument/ev-document-find.c @@ -29,6 +29,15 @@ ev_document_find_default_init (EvDocumentFindInterface *klass) { } +/** + * ev_document_find_find_text: + * @document_find: an #EvDocumentFind + * @page: an #EvPage + * @text: text to find + * @case_sensitive: whether to match the string case + * + * Returns: (transfer full) (element-type EvRectangle): a list of results + */ GList * ev_document_find_find_text (EvDocumentFind *document_find, EvPage *page, diff --git a/libdocument/ev-document-images.c b/libdocument/ev-document-images.c index e65f2646..4316a19a 100644 --- a/libdocument/ev-document-images.c +++ b/libdocument/ev-document-images.c @@ -37,6 +37,13 @@ ev_document_images_get_image_mapping (EvDocumentImages *document_images, return iface->get_image_mapping (document_images, page); } +/** + * ev_document_images_get_image: + * @document_images: an #EvDocumentImages + * @image: an #EvImage + * + * Returns: (transfer full): a #GdkPixbuf + */ GdkPixbuf * ev_document_images_get_image (EvDocumentImages *document_images, EvImage *image) diff --git a/libdocument/ev-document-layers.c b/libdocument/ev-document-layers.c index 79eca345..a05b1d46 100644 --- a/libdocument/ev-document-layers.c +++ b/libdocument/ev-document-layers.c @@ -38,6 +38,12 @@ ev_document_layers_has_layers (EvDocumentLayers *document_layers) return iface->has_layers (document_layers); } +/** + * ev_document_layers_get_layers: + * @document_layers: an #EvDocumentLayers + * + * Returns: (transfer full): a #GtkTreeModel + */ GtkTreeModel * ev_document_layers_get_layers (EvDocumentLayers *document_layers) { diff --git a/libdocument/ev-document-links.c b/libdocument/ev-document-links.c index 42ffc59a..af41568d 100644 --- a/libdocument/ev-document-links.c +++ b/libdocument/ev-document-links.c @@ -43,6 +43,12 @@ ev_document_links_has_document_links (EvDocumentLinks *document_links) return retval; } +/** + * ev_document_links_get_links_model: + * @document_links: an #EvDocumentLinks + * + * Returns: (transfer full): a #GtkTreeModel + */ GtkTreeModel * ev_document_links_get_links_model (EvDocumentLinks *document_links) { @@ -63,6 +69,13 @@ ev_document_links_get_links (EvDocumentLinks *document_links, return iface->get_links (document_links, page); } +/** + * ev_document_links_find_link_dest: + * @document_links: an #EvDocumentLinks + * @link_name: the link name + * + * Returns: (transfer full): an #EvLinkDest + */ EvLinkDest * ev_document_links_find_link_dest (EvDocumentLinks *document_links, const gchar *link_name) diff --git a/libdocument/ev-document-misc.c b/libdocument/ev-document-misc.c index 6794d050..529c5b97 100644 --- a/libdocument/ev-document-misc.c +++ b/libdocument/ev-document-misc.c @@ -94,6 +94,14 @@ create_thumbnail_frame (int width, return retval; } +/** + * ev_document_misc_get_thumbnail_frame: + * @width: the desired width + * @height: the desired height + * @source_pixbuf: a #GdkPixbuf + * + * Returns: (transfer full): a #GdkPixbuf + */ GdkPixbuf * ev_document_misc_get_thumbnail_frame (int width, int height, @@ -102,6 +110,14 @@ ev_document_misc_get_thumbnail_frame (int width, return create_thumbnail_frame (width, height, source_pixbuf, TRUE); } +/** + * ev_document_misc_get_loading_thumbnail: + * @width: the desired width + * @height: the desired height + * @inverted_colors: whether to invert colors + * + * Returns: (transfer full): a #GdkPixbuf + */ GdkPixbuf * ev_document_misc_get_loading_thumbnail (int width, int height, @@ -199,6 +215,12 @@ ev_document_misc_surface_from_pixbuf (GdkPixbuf *pixbuf) return surface; } +/** + * ev_document_misc_pixbuf_from_surface: + * @surface: a #cairo_surface_t + * + * Returns: (transfer full): a #GdkPixbuf + */ GdkPixbuf * ev_document_misc_pixbuf_from_surface (cairo_surface_t *surface) { diff --git a/libdocument/ev-document-transition.c b/libdocument/ev-document-transition.c index 0c5b6979..cf305cf4 100644 --- a/libdocument/ev-document-transition.c +++ b/libdocument/ev-document-transition.c @@ -40,6 +40,13 @@ ev_document_transition_get_page_duration (EvDocumentTransition *document_trans, return -1; } +/** + * ev_document_transition_get_effect: + * @document_trans: an #EvDocumentTransition + * @page: a page index + * + * Returns: (transfer full): an #EvTransitionEffect + */ EvTransitionEffect * ev_document_transition_get_effect (EvDocumentTransition *document_trans, gint page) -- cgit v1.2.1