GNOME.org
 

[evince] libview: Add missing Since: and Deprecated: annotations

commit 9208f445ce8fdee3bd3bdada7c0ef72fa6dc670a
Author: Christian Persch <chpe gnome org>
Date:   Tue Jul 30 19:20:13 2013 +0200

    libview: Add missing Since: and Deprecated: annotations

 libview/ev-document-model.c |   36 +++++++++++++++++
 libview/ev-document-model.h |    8 ++++
 libview/ev-jobs.c           |   24 +++++++++++
 libview/ev-page-cache.c     |   22 +++++++++++
 libview/ev-view.c           |   89 +++++++++++++++++++++++++++++++++++++++++--
 5 files changed, 175 insertions(+), 4 deletions(-)
---
diff --git a/libview/ev-document-model.c b/libview/ev-document-model.c
index 5e22d3f..85be89f 100644
--- a/libview/ev-document-model.c
+++ b/libview/ev-document-model.c
@@ -552,6 +552,15 @@ _ev_document_model_set_dual_page_internal (EvDocumentModel *model,
        g_object_notify (G_OBJECT (model), "dual-page");
 }
 
+/**
+ * ev_document_model_set_page_layout:
+ * @model: a #EvDocumentModel
+ * @layout: a #EvPageLayout
+ *
+ * Sets the document model's page layout to @layout.
+ *
+ * Since: 3.8
+ */
 void
 ev_document_model_set_page_layout (EvDocumentModel *model,
                                   EvPageLayout     layout)
@@ -569,6 +578,14 @@ ev_document_model_set_page_layout (EvDocumentModel *model,
        _ev_document_model_set_dual_page_internal (model, layout == EV_PAGE_LAYOUT_DUAL);
 }
 
+/**
+ * ev_document_model_get_page_layout:
+ * @model: a #EvDocumentModel
+ *
+ * Returns: the document model's page layout
+ *
+ * Since: 3.8
+ */
 EvPageLayout
 ev_document_model_get_page_layout (EvDocumentModel *model)
 {
@@ -650,6 +667,16 @@ ev_document_model_get_continuous (EvDocumentModel *model)
        return model->continuous;
 }
 
+/**
+ * ev_document_model_set_dual_page:
+ * @model: a #EvDocumentModel
+ * @dual_page: whether to enable dual page mode
+ *
+ * Sets the document model's page layout to %EV_PAGE_LAYOUT_SINGLE or
+ * %EV_PAGE_LAYOUT_DUAL.
+ *
+ * Deprecated: 3.8: Use ev_document_model_set_page_layout() instead
+ */
 void
 ev_document_model_set_dual_page (EvDocumentModel *model,
                                 gboolean         dual_page)
@@ -662,6 +689,15 @@ ev_document_model_set_dual_page (EvDocumentModel *model,
        ev_document_model_set_page_layout (model, layout);
 }
 
+/**
+ * ev_document_model_get_dual_page:
+ * @model: a #EvDocumentModel
+ *
+ * Returns: whether the document model's page layout is set to
+ * %EV_PAGE_LAYOUT_DUAL.
+ *
+ * Deprecated: 3.8: Use ev_document_model_get_page_layout() instead
+ */
 gboolean
 ev_document_model_get_dual_page (EvDocumentModel *model)
 {
diff --git a/libview/ev-document-model.h b/libview/ev-document-model.h
index b9cc44a..37257ab 100644
--- a/libview/ev-document-model.h
+++ b/libview/ev-document-model.h
@@ -36,6 +36,14 @@ G_BEGIN_DECLS
 #define EV_IS_DOCUMENT_MODEL_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), EV_TYPE_DOCUMENT_MODEL))
 #define EV_DOCUMENT_MODEL_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), EV_TYPE_DOCUMENT_MODEL, 
EvDocumentModelClass))
 
+/**
+ * EvSizingMode:
+ * @EV_SIZING_FIT_PAGE: Since: 3.8
+ * @EV_SIZING_BEST_FIT: Same as %EV_SIZING_FIT_PAGE. Deprecated:
+ * @EV_SIZING_FIT_WIDTH:
+ * @EV_SIZING_FREE:
+ * @EV_SIZING_AUTOMATIC: Since: 3.8
+ */
 typedef enum {
         EV_SIZING_FIT_PAGE,
        EV_SIZING_BEST_FIT = EV_SIZING_FIT_PAGE, /* Deprecated */
diff --git a/libview/ev-jobs.c b/libview/ev-jobs.c
index e000e62..7e97d63 100644
--- a/libview/ev-jobs.c
+++ b/libview/ev-jobs.c
@@ -425,6 +425,8 @@ ev_job_links_new (EvDocument *document)
  * Get a #GtkTreeModel loaded with the links
  *
  * Return value: (transfer none): The #GtkTreeModel loaded
+ *
+ * Since: 3.6
  */
 GtkTreeModel *
 ev_job_links_get_model (EvJobLinks *job)
@@ -894,6 +896,13 @@ ev_job_thumbnail_new (EvDocument *document,
        return EV_JOB (job);
 }
 
+/**
+ * ev_job_thumbnail_set_has_frame:
+ * @job:
+ * @has_frame:
+ *
+ * Since: 3.8
+ */
 void
 ev_job_thumbnail_set_has_frame (EvJobThumbnail  *job,
                                 gboolean         has_frame)
@@ -1654,6 +1663,13 @@ ev_job_find_new (EvDocument  *document,
        return EV_JOB (job);
 }
 
+/**
+ * ev_job_find_set_options:
+ * @job:
+ * @options:
+ *
+ * Since: 3.6
+ */
 void
 ev_job_find_set_options (EvJobFind     *job,
                          EvFindOptions  options)
@@ -1663,6 +1679,14 @@ ev_job_find_set_options (EvJobFind     *job,
         job->case_sensitive = options & EV_FIND_CASE_SENSITIVE;
 }
 
+/**
+ * ev_job_find_get_options:
+ * @job:
+ *
+ * Returns: the job's find options
+ *
+ * Since: 3.6
+ */
 EvFindOptions
 ev_job_find_get_options (EvJobFind *job)
 {
diff --git a/libview/ev-page-cache.c b/libview/ev-page-cache.c
index 8e3271d..13475e0 100644
--- a/libview/ev-page-cache.c
+++ b/libview/ev-page-cache.c
@@ -579,6 +579,15 @@ ev_page_cache_get_text_layout (EvPageCache  *cache,
        return FALSE;
 }
 
+/**
+ * ev_page_cache_get_text_attrs:
+ * @cache: a #EvPageCache
+ * @page:
+ *
+ * FIXME
+ *
+ * Since: 3.10
+ */
 PangoAttrList *
 ev_page_cache_get_text_attrs (EvPageCache    *cache,
                              gint            page)
@@ -601,6 +610,19 @@ ev_page_cache_get_text_attrs (EvPageCache    *cache,
        return data->text_attrs;
 }
 
+/**
+ * ev_page_cache_get_text_log_attrs:
+ * @cache: a #EvPageCache
+ * @page:
+ * @log_attrs: (out) (transfer full) (array length=n_attrs):
+ * @n_attrs: (out):
+ *
+ * FIXME
+ *
+ * Returns: %TRUE on success with @log_attrs filled in, %FALSE otherwise
+ *
+ * Since: 3.10
+ */
 gboolean
 ev_page_cache_get_text_log_attrs (EvPageCache   *cache,
                                   gint           page,
diff --git a/libview/ev-view.c b/libview/ev-view.c
index 57afdb5..fa80c9f 100644
--- a/libview/ev-view.c
+++ b/libview/ev-view.c
@@ -45,10 +45,6 @@
 #include "ev-view-type-builtins.h"
 #include "ev-debug.h"
 
-#define EV_VIEW_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), EV_TYPE_VIEW, EvViewClass))
-#define EV_IS_VIEW_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), EV_TYPE_VIEW))
-#define EV_VIEW_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), EV_TYPE_VIEW, EvViewClass))
-
 enum {
        SIGNAL_SCROLL,
        SIGNAL_HANDLE_LINK,
@@ -924,6 +920,14 @@ compute_scroll_increment (EvView        *view,
 
 }
 
+/**
+ * ev_view_scroll:
+ * @view: a #EvView
+ * @scroll:
+ * @horizontal:
+ *
+ * Deprecated: 3.10
+ */
 void
 ev_view_scroll (EvView        *view,
                GtkScrollType  scroll,
@@ -3341,6 +3345,14 @@ ev_view_pend_cursor_blink (EvView *view)
                                                                 (GSourceFunc)blink_cb, view);
 }
 
+/**
+ * ev_view_supports_caret_navigation:
+ * @view: a #EvView
+ *
+ * Returns: whether the document supports caret navigation
+ *
+ * Since: 3.10
+ */
 gboolean
 ev_view_supports_caret_navigation (EvView *view)
 {
@@ -3356,6 +3368,15 @@ ev_view_supports_caret_navigation (EvView *view)
        return TRUE;
 }
 
+/**
+ * ev_view_set_caret_navigation_enabled:
+ * @view: a #EvView
+ * @enabled: whether to enable caret navigation mode
+ *
+ * Enables or disables caret navigation mode for the document.
+ *
+ * Since: 3.10
+ */
 void
 ev_view_set_caret_navigation_enabled (EvView   *view,
                                      gboolean enabled)
@@ -3371,6 +3392,14 @@ ev_view_set_caret_navigation_enabled (EvView   *view,
        }
 }
 
+/**
+ * ev_view_get_caret_navigation_enabled:
+ * @view: a #EvView
+ *
+ * Returns: whether caret navigation mode is enabled for the document
+ *
+ * Since: 3.10
+ */
 gboolean
 ev_view_is_caret_navigation_enabled (EvView *view)
 {
@@ -3379,6 +3408,14 @@ ev_view_is_caret_navigation_enabled (EvView *view)
        return view->caret_enabled;
 }
 
+/**
+ * ev_view_set_caret_cursor_position:
+ * @view: a #EvView
+ * @page:
+ * @offset:
+ *
+ * Since: 3.10
+ */
 void
 ev_view_set_caret_cursor_position (EvView *view,
                                   guint   page,
@@ -6180,6 +6217,11 @@ ev_view_class_init (EvViewClass *class)
                                                               FALSE,
                                                               G_PARAM_READABLE |
                                                               G_PARAM_STATIC_STRINGS));
+       /**
+        * EvView:can-zoom-in:
+        *
+        * Since: 3.8
+        */
        g_object_class_install_property (object_class,
                                         PROP_CAN_ZOOM_IN,
                                         g_param_spec_boolean ("can-zoom-in",
@@ -6188,6 +6230,11 @@ ev_view_class_init (EvViewClass *class)
                                                               TRUE,
                                                               G_PARAM_READABLE |
                                                               G_PARAM_STATIC_STRINGS));
+       /**
+        * EvView:can-zoom-out:
+        *
+        * Since: 3.8
+        */
        g_object_class_install_property (object_class,
                                         PROP_CAN_ZOOM_OUT,
                                         g_param_spec_boolean ("can-zoom-out",
@@ -6571,6 +6618,13 @@ ev_view_set_page_cache_size (EvView *view,
        view_update_scale_limits (view);
 }
 
+/**
+ * ev_view_set_loading:
+ * @view:
+ * @loading:
+ *
+ * Deprecated: 3.8
+ */
 void
 ev_view_set_loading (EvView      *view,
                     gboolean      loading)
@@ -6582,6 +6636,14 @@ ev_view_set_loading (EvView        *view,
        g_object_notify (G_OBJECT (view), "is-loading");
 }
 
+/**
+ * ev_view_is_loading:
+ * @view:
+ *
+ * Returns: %TRUE iff the view is currently loading a document
+ *
+ * Since: 3.8
+ */
 gboolean
 ev_view_is_loading (EvView *view)
 {
@@ -7329,6 +7391,13 @@ find_job_updated_cb (EvJobFind *job, gint page, EvView *view)
        ev_view_find_changed (view, ev_job_find_get_results (job), page);
 }
 
+/**
+ * ev_view_find_started:
+ * @view:
+ * @job:
+ *
+ * Since: 3.6
+ */
 void
 ev_view_find_started (EvView *view, EvJobFind *job)
 {
@@ -7346,6 +7415,8 @@ ev_view_find_started (EvView *view, EvJobFind *job)
  * @view: an #EvView
  * @results: the results as returned by ev_job_find_get_results()
  * @page: page index
+ *
+ * Deprecated: 3.6: Use ev_view_find_started() instead
  */
 void
 ev_view_find_changed (EvView *view, GList **results, gint page)
@@ -7396,6 +7467,16 @@ ev_view_find_previous (EvView *view)
        }
 }
 
+/**
+ * ev_view_find_set_result:
+ * @view: a #EvView
+ * @page:
+ * @result:
+ *
+ * FIXME
+ *
+ * Since: 3.10
+ */
 void
 ev_view_find_set_result (EvView *view, gint page, gint result)
 {
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]