diff options
| author | Pranav Kant <pranavk@gnome.org> | 2015-07-22 20:25:36 +0530 |
|---|---|---|
| committer | Ashod Nakashian <ashod.nakashian@collabora.co.uk> | 2016-02-07 22:00:19 -0500 |
| commit | 341e235258e2cb51260354a3c744dac4cc936b3e (patch) | |
| tree | c9d29e7cf9068529b024c8f90b95b9ec81d4ac69 /libreofficekit | |
| parent | 150f78d311a84a0049e2798628b584cd40660ea6 (diff) | |
lokdocview, tilebuffer: Add DOxygen comments
Change-Id: I27377f0a758729a7877cfc6a56ea1b4bb3d1c3c9
(cherry picked from commit e032b64451347f5079c2a5bfbfda8d843db91e2d)
Diffstat (limited to 'libreofficekit')
| -rw-r--r-- | libreofficekit/source/gtk/lokdocview.cxx | 12 | ||||
| -rw-r--r-- | libreofficekit/source/gtk/tilebuffer.hxx | 5 |
2 files changed, 17 insertions, 0 deletions
diff --git a/libreofficekit/source/gtk/lokdocview.cxx b/libreofficekit/source/gtk/lokdocview.cxx index 15906129876a..f54e9ad206fe 100644 --- a/libreofficekit/source/gtk/lokdocview.cxx +++ b/libreofficekit/source/gtk/lokdocview.cxx @@ -37,6 +37,7 @@ // Number of handles around a graphic selection. #define GRAPHIC_HANDLE_COUNT 8 +/// Private struct used by this GObject type struct _LOKDocViewPrivate { gchar* m_aLOPath; @@ -162,6 +163,7 @@ G_DEFINE_TYPE_WITH_CODE (LOKDocView, lok_doc_view, GTK_TYPE_DRAWING_AREA, #endif static GThreadPool* lokThreadPool; +/// Helper struct used to pass the data from soffice thread -> main thread. struct CallbackData { int m_nType; @@ -174,8 +176,16 @@ struct CallbackData m_pDocView(pDocView) {} }; +/** + A struct that we use to store the data about the LOK call. + + Object of this type is passed with all the LOK calls, + so that they can be idenitified. Additionally, it also contains + the data that LOK call needs. +*/ struct LOEvent { + /// To identify the type of LOK call int m_nType; const gchar* m_pCommand; const gchar* m_pArguments; @@ -187,6 +197,8 @@ struct LOEvent int m_nCharCode; int m_nKeyCode; + + /// Constructor to easily instantiate an object for LOK call of `type' type. LOEvent(int type) : m_nType(type) {} diff --git a/libreofficekit/source/gtk/tilebuffer.hxx b/libreofficekit/source/gtk/tilebuffer.hxx index f704ae1f8069..cfb63a6b33a9 100644 --- a/libreofficekit/source/gtk/tilebuffer.hxx +++ b/libreofficekit/source/gtk/tilebuffer.hxx @@ -131,6 +131,11 @@ class TileBuffer Tile m_DummyTile; }; +/** + Helper struct used to pass the data from main thread to spawned threads. + Spawned threads are responsible for calling paintTile, and store the result + in tile buffer. +*/ struct GetTileCallbackData { int m_nX; |