Blame SOURCES/0077-lokdocview-tilebuffer-Add-DOxygen-comments.patch

f325b2
From 490b3e99671ae4fee3b4e4bb2cc9b40e66f26e3c Mon Sep 17 00:00:00 2001
f325b2
From: Pranav Kant <pranavk@gnome.org>
f325b2
Date: Wed, 22 Jul 2015 20:25:36 +0530
f325b2
Subject: [PATCH 077/398] lokdocview, tilebuffer: Add DOxygen comments
f325b2
f325b2
Change-Id: I27377f0a758729a7877cfc6a56ea1b4bb3d1c3c9
f325b2
(cherry picked from commit e032b64451347f5079c2a5bfbfda8d843db91e2d)
f325b2
---
f325b2
 libreofficekit/source/gtk/lokdocview.cxx | 12 ++++++++++++
f325b2
 libreofficekit/source/gtk/tilebuffer.hxx |  5 +++++
f325b2
 2 files changed, 17 insertions(+)
f325b2
f325b2
diff --git a/libreofficekit/source/gtk/lokdocview.cxx b/libreofficekit/source/gtk/lokdocview.cxx
f325b2
index 0740e04dd6c8..ddb3c386b0ca 100644
f325b2
--- a/libreofficekit/source/gtk/lokdocview.cxx
f325b2
+++ b/libreofficekit/source/gtk/lokdocview.cxx
f325b2
@@ -36,6 +36,7 @@
f325b2
 // Number of handles around a graphic selection.
f325b2
 #define GRAPHIC_HANDLE_COUNT 8
f325b2
 
f325b2
+/// Private struct used by this GObject type
f325b2
 struct _LOKDocViewPrivate
f325b2
 {
f325b2
     gchar* m_aLOPath;
f325b2
@@ -162,6 +163,7 @@ G_DEFINE_TYPE_WITH_CODE (LOKDocView, lok_doc_view, GTK_TYPE_DRAWING_AREA,
f325b2
 
f325b2
 static GThreadPool* lokThreadPool;
f325b2
 
f325b2
+/// Helper struct used to pass the data from soffice thread -> main thread.
f325b2
 struct CallbackData
f325b2
 {
f325b2
     int m_nType;
f325b2
@@ -174,8 +176,16 @@ struct CallbackData
f325b2
           m_pDocView(pDocView) {}
f325b2
 };
f325b2
 
f325b2
+/**
f325b2
+   A struct that we use to store the data about the LOK call.
f325b2
+
f325b2
+   Object of this type is passed with all the LOK calls,
f325b2
+   so that they can be idenitified. Additionally, it also contains
f325b2
+   the data that LOK call needs.
f325b2
+*/
f325b2
 struct LOEvent
f325b2
 {
f325b2
+    /// To identify the type of LOK call
f325b2
     int m_nType;
f325b2
     const gchar* m_pCommand;
f325b2
     const gchar* m_pArguments;
f325b2
@@ -187,6 +197,8 @@ struct LOEvent
f325b2
     int m_nCharCode;
f325b2
     int m_nKeyCode;
f325b2
 
f325b2
+
f325b2
+    /// Constructor to easily instantiate an object for LOK call of `type' type.
f325b2
     LOEvent(int type)
f325b2
         : m_nType(type) {}
f325b2
 
f325b2
diff --git a/libreofficekit/source/gtk/tilebuffer.hxx b/libreofficekit/source/gtk/tilebuffer.hxx
f325b2
index 50de72d9d3b9..40fb2abbae6d 100644
f325b2
--- a/libreofficekit/source/gtk/tilebuffer.hxx
f325b2
+++ b/libreofficekit/source/gtk/tilebuffer.hxx
f325b2
@@ -131,6 +131,11 @@ class TileBuffer
f325b2
     Tile m_DummyTile;
f325b2
 };
f325b2
 
f325b2
+/**
f325b2
+   Helper struct used to pass the data from main thread to spawned threads.
f325b2
+   Spawned threads are responsible for calling paintTile, and store the result
f325b2
+   in tile buffer.
f325b2
+*/
f325b2
 struct GetTileCallbackData
f325b2
 {
f325b2
     int m_nX;
f325b2
-- 
f325b2
2.12.0
f325b2