Doxygen issues

src/blackinput/keyboard.h

@@ -19,7 +19,7 @@
 namespace BlackInput
 {
     /*!
-     * \brief Abstract interface for native keyboard handling.
+     * Abstract interface for native keyboard handling.
      * \todo Add implementation for Linux and OSX.
      */
     class IKeyboard : public QObject
@@ -44,7 +44,7 @@ namespace BlackInput
         virtual void setKeysToMonitor(const BlackMisc::Hardware::CKeyboardKeyList &keylist) = 0;
 
         /*!
-         * \brief Select a key combination as hotkey. This method returns immediatly.
+         * Select a key combination as hotkey. This method returns immediatly.
          *        Listen for signals keySelectionChanged and keySelectionFinished
          *        to retrieve the user input.
          * \param ignoreNextKey
@@ -54,7 +54,7 @@ namespace BlackInput
         virtual void startCapture(bool ignoreNextKey) = 0;
 
         /*!
-         * \brief Triggers a key event manually and calls the registered functions.
+         * Triggers a key event manually and calls the registered functions.
          * \param key
          * \param isPressed
          */
@@ -66,13 +66,13 @@ namespace BlackInput
     signals:
 
         /*!
-         * \brief Key selection has changed, but is not finished yet.
+         * Key selection has changed, but is not finished yet.
          * \param key
          */
         void keySelectionChanged(BlackMisc::Hardware::CKeyboardKey key);
 
         /*!
-         * \brief Key selection has finished.
+         * Key selection has finished.
          * \param key
          */
         void keySelectionFinished(BlackMisc::Hardware::CKeyboardKey key);
@@ -86,7 +86,7 @@ namespace BlackInput
     protected:
 
         /*!
-         * \brief Initializes the platform keyboard device
+         * Initializes the platform keyboard device
          */
         virtual bool init() = 0;
 
@@ -96,4 +96,4 @@ namespace BlackInput
     };
 }
 
-#endif // BLACKINPUT_KEYBOARD_H
+#endif // guard

src/blackinput/osx/keyboard_mac.h

@@ -17,16 +17,16 @@
 #include <QHash>
 
 class __CGEvent;
-typedef __CGEvent* CGEventRef;
 
-typedef unsigned int CGEventType;
+typedef __CGEvent* CGEventRef; //!< Mac event definition
+typedef unsigned int CGEventType; //!< Max event type definition
 
 class __CGEventTapProxy;
-typedef __CGEventTapProxy* CGEventTapProxy;
+typedef __CGEventTapProxy* CGEventTapProxy; //!< Max event proxy definition
 
 namespace BlackInput
 {
-    //! \brief Mac OSX implemenation of IKeyboard using hook procedure
+    //! Mac OSX implemenation of IKeyboard using hook procedure
     //! \todo Change QHash to a CCollection object
     class CKeyboardMac : public IKeyboard
     {
@@ -34,13 +34,13 @@ namespace BlackInput
 
     public:
 
-        //! \brief Copy Constructor
+        //! Copy Constructor
         CKeyboardMac(CKeyboardMac const&) = delete;
 
-        //! \brief Assignment operator
+        //! Assignment operator
         CKeyboardMac &operator=(CKeyboardMac const&) = delete;
 
-        //! \brief Destructor
+        //! Destructor
         virtual ~CKeyboardMac();
 
         //! Set the list of keys to monitor
@@ -52,6 +52,7 @@ namespace BlackInput
         //! \copydoc IKeyboard::triggerKey()
         virtual void triggerKey(const BlackMisc::Hardware::CKeyboardKey &key, bool isPressed) override;
 
+        //! Process key event
         virtual void processKeyEvent(CGEventType type, CGEventRef event);
 
     protected:
@@ -67,7 +68,7 @@ namespace BlackInput
         CKeyboardMac(QObject *parent = nullptr);
 
         /*!
-         * \brief Constructor
+         * Constructor
          * \param keySet
          * \param isFinished
          */