[evince/wip/gpoo/fix-gi-warnings: 2/2] libdocument: Fix annotations in functions
- From: Germán Poo-Caamaño <gpoo src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [evince/wip/gpoo/fix-gi-warnings: 2/2] libdocument: Fix annotations in functions
- Date: Tue, 29 Mar 2022 02:56:55 +0000 (UTC)
commit b4b480ddcbe0b874ae7a7993ec9d12f5e06fac8d
Author: Germán Poo-Caamaño <gpoo gnome org>
Date: Mon Mar 28 23:54:43 2022 -0300
libdocument: Fix annotations in functions
Add missing annotations, remove duplications, and fix arguments.
libdocument/ev-annotation.c | 2 +-
libdocument/ev-document-factory.c | 12 ++++++++++++
libdocument/ev-document-info.c | 1 -
libdocument/ev-document.c | 2 +-
libdocument/ev-document.h | 2 +-
libdocument/ev-link-action.c | 9 ++++++++-
6 files changed, 23 insertions(+), 5 deletions(-)
---
diff --git a/libdocument/ev-annotation.c b/libdocument/ev-annotation.c
index 739625083..1613fb2ab 100644
--- a/libdocument/ev-annotation.c
+++ b/libdocument/ev-annotation.c
@@ -727,7 +727,7 @@ ev_annotation_set_rgba (EvAnnotation *annot,
}
/**
- * ev_annotation_set_area:
+ * ev_annotation_get_area:
* @annot: an #EvAnnotation
* @area: (out): a #EvRectangle to be filled with the annotation area
*
diff --git a/libdocument/ev-document-factory.c b/libdocument/ev-document-factory.c
index 8feb47e21..19085eced 100644
--- a/libdocument/ev-document-factory.c
+++ b/libdocument/ev-document-factory.c
@@ -697,11 +697,23 @@ ev_backends_manager_get_document_module_name (EvDocument *document)
return info->module_name;
}
+/**
+ * ev_backends_manager_get_document_type_info: (skip)
+ * @document: a #EvDocument
+ *
+ * Returns: a EvTypeInfo
+ */
EvTypeInfo *ev_backends_manager_get_document_type_info (EvDocument *document)
{
return (EvTypeInfo *) get_backend_info_for_document (document);
}
+/**
+ * ev_backends_manager_get_all_types_info: (skip)
+ *
+ * Returns: @list: (element-type EvBackendInfo): a shallow copy of #GList
+ * containing #EvBackendInfo objects
+ */
GList *
ev_backends_manager_get_all_types_info (void)
{
diff --git a/libdocument/ev-document-info.c b/libdocument/ev-document-info.c
index 84466c0a5..15e7c5835 100644
--- a/libdocument/ev-document-info.c
+++ b/libdocument/ev-document-info.c
@@ -39,7 +39,6 @@ G_DEFINE_BOXED_TYPE (EvDocumentInfo, ev_document_info, ev_document_info_copy, ev
/**
* ev_document_info_new:
- * @info: a #EvDocumentInfo
*
* Returns: (transfer full): a new, empty #EvDocumentInfo
*/
diff --git a/libdocument/ev-document.c b/libdocument/ev-document.c
index d32640e3e..c77bd479b 100644
--- a/libdocument/ev-document.c
+++ b/libdocument/ev-document.c
@@ -756,7 +756,7 @@ ev_document_synctex_backward_search (EvDocument *document,
}
/**
- * ev_document_synctex_forward_search:
+ * ev_document_synctex_forward_search: (skip)
* @document: a #EvDocument
* @source_link: a #EvSourceLink
*
diff --git a/libdocument/ev-document.h b/libdocument/ev-document.h
index e2415b3f8..bda230193 100644
--- a/libdocument/ev-document.h
+++ b/libdocument/ev-document.h
@@ -102,7 +102,7 @@ struct _EvDocumentClass
EvPage * (* get_page) (EvDocument *document,
gint index);
void (* get_page_size) (EvDocument *document,
- EvPage *page,
+ EvPage *page_index,
double *width,
double *height);
gchar * (* get_page_label) (EvDocument *document,
diff --git a/libdocument/ev-link-action.c b/libdocument/ev-link-action.c
index f1d44ffee..da28f5f22 100644
--- a/libdocument/ev-link-action.c
+++ b/libdocument/ev-link-action.c
@@ -163,7 +163,7 @@ ev_link_action_get_toggle_list (EvLinkAction *self)
* ev_link_action_get_reset_fields:
* @self: an #EvLinkAction
*
- * Returns: (transfer none) (element-type gchar *): a list of fields to reset
+ * Returns: (transfer none) (element-type gchar*): a list of fields to reset
*/
GList *
ev_link_action_get_reset_fields (EvLinkAction *self)
@@ -542,6 +542,13 @@ ev_link_action_new_layers_state (GList *show_list,
NULL));
}
+/**
+ * ev_link_action_new_reset_form:
+ * @fields: (element-type gchar*): a list of fields to reset
+ * @exclude_fields: whether to exclude reset fields when resetting form
+ *
+ * Returns: (transfer full): a new #EvLinkAction
+ */
EvLinkAction *
ev_link_action_new_reset_form (GList *reset_fields,
gboolean exclude_reset_fields)
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]