[Libreoffice-commits] core.git: Branch 'libreoffice-5-1' - include/LibreOfficeKit

[Pranav Kant]

 include/LibreOfficeKit/LibreOfficeKitGtk.h |    7 +++++++
 1 file changed, 7 insertions(+)

New commits:
commit 2f5643d7fa1009155e900a89918d5cee3265c137
Author: Pranav Kant <pranavk at libreoffice.org>
Date:   Thu Dec 17 20:33:06 2015 +0530

    lokdocview: Added some missing comments/annotations
    
    Change-Id: I2f62bae37719ce96677a5ca6ffd93c8edb325a6a
    Reviewed-on: https://gerrit.libreoffice.org/20777
    Reviewed-by: David Tardon <dtardon at redhat.com>
    Tested-by: David Tardon <dtardon at redhat.com>
    (cherry picked from commit 9c8c3acffa304e2d85dcbbdb5bf9decc9b255b13)
    Reviewed-on: https://gerrit.libreoffice.org/21266
    Tested-by: Jenkins <ci at libreoffice.org>
    Reviewed-by: Pranav Kant <pranavk at gnome.org>

diff --git a/include/LibreOfficeKit/LibreOfficeKitGtk.h b/include/LibreOfficeKit/LibreOfficeKitGtk.h
index c3cba8f..62d2e7f 100644
--- a/include/LibreOfficeKit/LibreOfficeKitGtk.h
+++ b/include/LibreOfficeKit/LibreOfficeKitGtk.h
@@ -123,12 +123,17 @@ gfloat                         lok_doc_view_get_zoom               (LOKDocView*
 /**
  * lok_doc_view_get_parts:
  * @pDocView: The #LOKDocView instance
+ *
+ * Returns: Part refers to either individual sheets in a Calc, or slides in Impress,
+ * and has no relevance for Writer.
  */
 gint                           lok_doc_view_get_parts              (LOKDocView* pDocView);
 
 /**
  * lok_doc_view_get_part:
  * @pDocView: The #LOKDocView instance
+ *
+ * Returns: Current part number of the document
  */
 gint                           lok_doc_view_get_part               (LOKDocView* pDocView);
 
@@ -144,6 +149,8 @@ void                           lok_doc_view_set_part               (LOKDocView*
  * lok_doc_view_get_part_name:
  * @pDocView: The #LOKDocView instance
  * @nPart:
+ *
+ * Returns: Get current part name of loaded document
  */
 gchar*                         lok_doc_view_get_part_name          (LOKDocView* pDocView,
                                                                     int nPart);