From e0f8a7031abfe6b6207019cddfb911fd33561495 Mon Sep 17 00:00:00 2001 From: Wolfgang Ulbrich Date: Sat, 12 Dec 2015 18:32:35 +0100 Subject: fix more introspections warnings partially taken from: https://git.gnome.org/browse/eog/commit/?id=1b22c52 https://git.gnome.org/browse/eog/commit/?id=e51fe58 --- src/eom-jobs.c | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ src/eom-jobs.h | 2 +- src/eom-list-store.c | 6 +++--- src/eom-thumb-view.c | 2 +- 4 files changed, 54 insertions(+), 5 deletions(-) diff --git a/src/eom-jobs.c b/src/eom-jobs.c index 1974ee4..05da974 100644 --- a/src/eom-jobs.c +++ b/src/eom-jobs.c @@ -351,6 +351,15 @@ eom_job_model_class_init (EomJobModelClass *class) EOM_JOB_CLASS (class)->run = eom_job_model_run; } +/** + * eom_job_model_new: + * @file_list: (element-type GFile): a #GFile list + * + * Creates a new #EomJob model. + * + * Returns: A #EomJob. + */ + EomJob * eom_job_model_new (GSList *file_list) { @@ -477,6 +486,16 @@ eom_job_transform_class_init (EomJobTransformClass *class) EOM_JOB_CLASS (class)->run = eom_job_transform_run; } +/** + * eom_job_transform_new: + * @images: (element-type EomImage) (transfer full): a #EomImage list + * @trans: a #EogTransform + * + * Create a new #EomJob for image transformation. + * + * Returns: A #EomJob. + */ + EomJob * eom_job_transform_new (GList *images, EomTransform *trans) { @@ -564,6 +583,15 @@ eom_job_save_class_init (EomJobSaveClass *class) EOM_JOB_CLASS (class)->run = eom_job_save_run; } +/** + * eom_job_save_new: + * @images: (element-type EomImage) (transfer full): a #EomImage list + * + * Creates a new #EomJob for image saving. + * + * Returns: A #EomJob. + */ + EomJob * eom_job_save_new (GList *images) { @@ -684,6 +712,17 @@ eom_job_save_as_class_init (EomJobSaveAsClass *class) EOM_JOB_CLASS (class)->run = eom_job_save_as_run; } +/** + * eom_job_save_as_new: + * @images: (element-type EomImage) (transfer full): a #EomImage list + * @converter: a URI converter + * file: a #GFile + * + * Creates a new #EomJob for save as. + * + * Returns: A #EomJob. + */ + EomJob * eom_job_save_as_new (GList *images, EomURIConverter *converter, GFile *file) { @@ -833,6 +872,16 @@ eom_job_copy_class_init (EomJobCopyClass *class) EOM_JOB_CLASS (class)->run = eom_job_copy_run; } +/** + * eom_job_copy_new: + * @images: (element-type EomImage) (transfer full): a #EomImage list + * @dest: destination path for the copy + * + * Creates a new #EomJob. + * + * Returns: A #EomJob. + */ + EomJob * eom_job_copy_new (GList *images, const gchar *dest) { diff --git a/src/eom-jobs.h b/src/eom-jobs.h index abc00e6..1667d43 100644 --- a/src/eom-jobs.h +++ b/src/eom-jobs.h @@ -265,7 +265,7 @@ EomJob *eom_job_save_as_new (GList *images, EomURIConverter *converter, GFile *file); -/*EomJobCopy */ +/* EomJobCopy */ GType eom_job_copy_get_type (void) G_GNUC_CONST; EomJob *eom_job_copy_new (GList *images, const gchar *dest); diff --git a/src/eom-list-store.c b/src/eom-list-store.c index 0e790e7..e379b09 100644 --- a/src/eom-list-store.c +++ b/src/eom-list-store.c @@ -538,7 +538,7 @@ eom_list_store_append_directory (EomListStore *store, /** * eom_list_store_add_files: * @store: An #EomListStore. - * @file_list: A %NULL-terminated list of #GFile's. + * @file_list: (element-type GFile): A %NULL-terminated list of #GFile's. * * Adds a list of #GFile's to @store. The given list * must be %NULL-terminated. @@ -667,7 +667,7 @@ eom_list_store_remove_image (EomListStore *store, EomImage *image) /** * eom_list_store_new_from_glist: - * @list: a %NULL-terminated list of #EomImage's. + * @list: (element-type EomImage): a %NULL-terminated list of #EomImage's. * * Creates a new #EomListStore from a list of #EomImage's. * The given list must be %NULL-terminated. @@ -727,7 +727,7 @@ eom_list_store_get_pos_by_image (EomListStore *store, EomImage *image) * Gets the #EomImage in the position @pos of @store. If there is * no image at position @pos, %NULL is returned. * - * Returns: the #EomImage in position @pos or %NULL. + * Returns: (transfer full): the #EomImage in position @pos or %NULL. * **/ EomImage * diff --git a/src/eom-thumb-view.c b/src/eom-thumb-view.c index b83c4ac..7eabe9d 100644 --- a/src/eom-thumb-view.c +++ b/src/eom-thumb-view.c @@ -920,7 +920,7 @@ eom_thumb_view_get_image_from_path (EomThumbView *thumbview, GtkTreePath *path) * is not ensured to be really the first selected image in @thumbview, but * generally, it will be. * - * Returns: A #EomImage. + * Returns: (transfer full): A #EomImage. **/ EomImage * eom_thumb_view_get_first_selected_image (EomThumbView *thumbview) -- cgit v1.2.1