From 7fae60a510ace6b0cea751f6dea0d840a3fce255 Mon Sep 17 00:00:00 2001
From: Mathew Sutcliffe <oktal3700@gmail.com>
Date: Thu, 3 Apr 2014 17:39:51 +0100
Subject: [PATCH] refs #204 doxygen comments

---
 src/blacksim/xplane/xbus/utils.h | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/src/blacksim/xplane/xbus/utils.h b/src/blacksim/xplane/xbus/utils.h
index afbc317c2..713bb97f6 100644
--- a/src/blacksim/xplane/xbus/utils.h
+++ b/src/blacksim/xplane/xbus/utils.h
@@ -56,6 +56,9 @@ class QXPlaneMessageHandler
     }
 
 public:
+    /*!
+     * Install the handler.
+     */
     static void install()
     {
         qInstallMessageHandler(handler);
@@ -83,6 +86,11 @@ class QSharedApplication : public QApplication
     }
 
 public:
+    /*!
+     * Returns a shared pointer to the QApplication.
+     *
+     * The QApplication will not be destroyed while this shared pointer exists.
+     */
     static QSharedPointer<QApplication> sharedInstance()
     {
         QSharedPointer<QApplication> ptr;
@@ -125,6 +133,10 @@ class QXPlaneEventLoop : public QObject
     }
 
 public:
+    /*!
+     * Registers the X-Plane callback which calls into the Qt event loop,
+     * unless one was already registered.
+     */
     static void exec()
     {
         if (! QApplication::instance()->findChild<QXPlaneEventLoop *>())