summaryrefslogtreecommitdiff
path: root/include/LibreOfficeKit/LibreOfficeKitGtk.h
diff options
context:
space:
mode:
authorPranav Kant <pranavk@libreoffice.org>2015-12-17 20:33:06 +0530
committerDavid Tardon <dtardon@redhat.com>2015-12-17 15:46:47 +0000
commit9c8c3acffa304e2d85dcbbdb5bf9decc9b255b13 (patch)
tree3f9d29dae29a49fbb6cd03b82e6a56be90902ab0 /include/LibreOfficeKit/LibreOfficeKitGtk.h
parenta2682e4b081a9a8c6814db768e4ee9e5390907ae (diff)
lokdocview: Added some missing comments/annotations
Change-Id: I2f62bae37719ce96677a5ca6ffd93c8edb325a6a Reviewed-on: https://gerrit.libreoffice.org/20777 Reviewed-by: David Tardon <dtardon@redhat.com> Tested-by: David Tardon <dtardon@redhat.com>
Diffstat (limited to 'include/LibreOfficeKit/LibreOfficeKitGtk.h')
-rw-r--r--include/LibreOfficeKit/LibreOfficeKitGtk.h7
1 files changed, 7 insertions, 0 deletions
diff --git a/include/LibreOfficeKit/LibreOfficeKitGtk.h b/include/LibreOfficeKit/LibreOfficeKitGtk.h
index 903a74256ffa..25b15fad0aab 100644
--- a/include/LibreOfficeKit/LibreOfficeKitGtk.h
+++ b/include/LibreOfficeKit/LibreOfficeKitGtk.h
@@ -123,12 +123,17 @@ float 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.
*/
int lok_doc_view_get_parts (LOKDocView* pDocView);
/**
* lok_doc_view_get_part:
* @pDocView: The #LOKDocView instance
+ *
+ * Returns: Current part number of the document
*/
int 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
*/
char* lok_doc_view_get_part_name (LOKDocView* pDocView,
int nPart);