kbrown / rpms / libreoffice

Forked from rpms/libreoffice 2 years ago
Clone

Blame SOURCES/0376-lokdocview-Added-some-missing-comments-annotations.patch

135360
From 13818ff71142e735c06b92c03c188527dedbac70 Mon Sep 17 00:00:00 2001
135360
From: Pranav Kant <pranavk@libreoffice.org>
135360
Date: Thu, 17 Dec 2015 20:33:06 +0530
135360
Subject: [PATCH 376/398] lokdocview: Added some missing comments/annotations
135360
135360
Change-Id: I2f62bae37719ce96677a5ca6ffd93c8edb325a6a
135360
Reviewed-on: https://gerrit.libreoffice.org/20777
135360
Reviewed-by: David Tardon <dtardon@redhat.com>
135360
Tested-by: David Tardon <dtardon@redhat.com>
135360
(cherry picked from commit 9c8c3acffa304e2d85dcbbdb5bf9decc9b255b13)
135360
Reviewed-on: https://gerrit.libreoffice.org/21266
135360
Tested-by: Jenkins <ci@libreoffice.org>
135360
Reviewed-by: Pranav Kant <pranavk@gnome.org>
135360
(cherry picked from commit 2f5643d7fa1009155e900a89918d5cee3265c137)
135360
---
135360
 include/LibreOfficeKit/LibreOfficeKitGtk.h | 7 +++++++
135360
 1 file changed, 7 insertions(+)
135360
135360
diff --git a/include/LibreOfficeKit/LibreOfficeKitGtk.h b/include/LibreOfficeKit/LibreOfficeKitGtk.h
135360
index c3cba8fe3417..62d2e7f29247 100644
135360
--- a/include/LibreOfficeKit/LibreOfficeKitGtk.h
135360
+++ b/include/LibreOfficeKit/LibreOfficeKitGtk.h
135360
@@ -123,12 +123,17 @@ gfloat                         lok_doc_view_get_zoom               (LOKDocView*
135360
 /**
135360
  * lok_doc_view_get_parts:
135360
  * @pDocView: The #LOKDocView instance
135360
+ *
135360
+ * Returns: Part refers to either individual sheets in a Calc, or slides in Impress,
135360
+ * and has no relevance for Writer.
135360
  */
135360
 gint                           lok_doc_view_get_parts              (LOKDocView* pDocView);
135360
 
135360
 /**
135360
  * lok_doc_view_get_part:
135360
  * @pDocView: The #LOKDocView instance
135360
+ *
135360
+ * Returns: Current part number of the document
135360
  */
135360
 gint                           lok_doc_view_get_part               (LOKDocView* pDocView);
135360
 
135360
@@ -144,6 +149,8 @@ void                           lok_doc_view_set_part               (LOKDocView*
135360
  * lok_doc_view_get_part_name:
135360
  * @pDocView: The #LOKDocView instance
135360
  * @nPart:
135360
+ *
135360
+ * Returns: Get current part name of loaded document
135360
  */
135360
 gchar*                         lok_doc_view_get_part_name          (LOKDocView* pDocView,
135360
                                                                     int nPart);
135360
-- 
135360
2.12.0
135360