From d7b45c97b30f109aff0be6602a8fc8103af71e7f Mon Sep 17 00:00:00 2001
From: Pranav Kant <pranavk@collabora.com>
Date: Tue, 21 Jun 2016 20:23:13 +0530
Subject: lok: Change version string to JSON format

Change-Id: Ie1264fed9964b09006980df2e151e170b48b4082
---
 include/LibreOfficeKit/LibreOfficeKit.hxx  |  9 ++++++---
 include/LibreOfficeKit/LibreOfficeKitGtk.h | 11 +++++++----
 2 files changed, 13 insertions(+), 7 deletions(-)

(limited to 'include/LibreOfficeKit')

diff --git a/include/LibreOfficeKit/LibreOfficeKit.hxx b/include/LibreOfficeKit/LibreOfficeKit.hxx
index 46a5e964f751..eae43af27178 100644
--- a/include/LibreOfficeKit/LibreOfficeKit.hxx
+++ b/include/LibreOfficeKit/LibreOfficeKit.hxx
@@ -550,10 +550,13 @@ public:
     /**
      * Get version information of the LOKit process
      *
-     * @returns string containing version information in format:
-     * PRODUCT_NAME PRODUCT_VERSION PRODUCT_EXTENSION BUILD_ID
+     * @returns JSON string containing version information in format:
+     * {ProductName: <>, ProductVersion: <>, ProductExtension: <>, BuildId: <>}
      *
-     * Eg: LibreOffice 5.3 .0.0 alpha0 <commit hash>
+     * Eg: {"ProductName": "LibreOffice",
+     * "ProductVersion": "5.3",
+     * "ProductExtension": ".0.0.alpha0",
+     * "BuildId": "<full 40 char git hash>"}
      */
     inline char* getVersionInfo()
     {
diff --git a/include/LibreOfficeKit/LibreOfficeKitGtk.h b/include/LibreOfficeKit/LibreOfficeKitGtk.h
index 4b4284e423fc..fc7cec141396 100644
--- a/include/LibreOfficeKit/LibreOfficeKitGtk.h
+++ b/include/LibreOfficeKit/LibreOfficeKitGtk.h
@@ -319,12 +319,15 @@ void                            lok_doc_view_set_document_password (LOKDocView*
  * lok_doc_view_get_version_info:
  * @pDocView: The #LOKDocView instance
  *
- * Get version information of underlying LOKit process
+ * Get version information of the LOKit process
  *
- * Returns: string containing version information in format
- * PRODUCT_NAME PRODUCT_VERSION PRODUCT_EXTENSION BUILD_ID
+ * Returns: JSON string containing version information in format:
+ * {ProductName: <>, ProductVersion: <>, ProductExtension: <>, BuildId: <>}
  *
- * Eg: LibreOffice 5.3 .0.0.alpha0 <commit hash>
+ * Eg: {"ProductName": "LibreOffice",
+ * "ProductVersion": "5.3",
+ * "ProductExtension": ".0.0.alpha0",
+ * "BuildId": "<full 40 char git hash>"}
  */
 gchar*                         lok_doc_view_get_version_info       (LOKDocView* pDocView);
 
-- 
cgit