chore: doxygen refactoring

nedrysoft · May 15, 2021 · a40836d · a40836d
1 parent 9e068d1
commit a40836d
Show file tree

Hide file tree

Showing 24 changed files with 155 additions and 52 deletions.
diff --git a/contributing.md b/contributing.md
@@ -2,7 +2,7 @@
 
 The following document contains a set of guidelines for contributing to the project.  Any pull-requests should be compliant with this guide.  Code style is often fluent, if you have a suggestion which you think will improve the readability of the code then please open an issue so that we can discuss that potentially modify the style guide to accommodate any new changes.
 
-#C++ Style Guide
+# C++ Style Guide
 
 The following guide should be followed to ensure consistent code throughout the project.
 

diff --git a/src/RibbonButton.h b/src/RibbonButton.h
@@ -73,8 +73,11 @@ namespace Nedrysoft { namespace Ribbon {
             auto updateStyleSheets(bool isDarkMode) -> void;
 
         private:
-            std::shared_ptr<RibbonButtonData> d;
-            Nedrysoft::ThemeSupport::ThemeSupport *m_themeSupport;     //! an instance of theme support
+            //! @cond
+
+            Nedrysoft::ThemeSupport::ThemeSupport *m_themeSupport;
+
+            //! @endcond
     };
 }}
 

diff --git a/src/RibbonButtonPlugin.h b/src/RibbonButtonPlugin.h
@@ -125,7 +125,11 @@ class RibbonButtonPlugin :
         void initialize(QDesignerFormEditorInterface *core) override;
 
     private:
-        bool m_initialized = false;                         //! holds whether designer has initialised the factory yet
+        //! @cond
+
+        bool m_initialized = false;
+
+        //! @endcond
 };
 
 #endif // NEDRYSOFT_RIBBONBUTTONPLUGIN_H
diff --git a/src/RibbonCheckBox.h b/src/RibbonCheckBox.h
@@ -63,7 +63,11 @@ namespace Nedrysoft { namespace Ribbon {
             auto updateStyleSheet(bool isDarkMode) -> void;
 
         private:
-            Nedrysoft::ThemeSupport::ThemeSupport *m_themeSupport;                 //! theme support instance
+            //! @cond
+
+            Nedrysoft::ThemeSupport::ThemeSupport *m_themeSupport;
+
+            //! @endcond
     };
 }}
 

diff --git a/src/RibbonCheckBoxPlugin.h b/src/RibbonCheckBoxPlugin.h
@@ -125,7 +125,11 @@ class RibbonCheckBoxPlugin :
         void initialize(QDesignerFormEditorInterface *core) override;
 
     private:
-        bool m_initialized = false;                         //! holds whether designer has initialised the factory yet
+        //! @cond
+
+        bool m_initialized = false;
+
+        //! @endcond
 };
 
 #endif // NEDRYSOFT_RIBBONCHECKBOXPLUGIN_H
diff --git a/src/RibbonComboBox.h b/src/RibbonComboBox.h
@@ -63,7 +63,11 @@ namespace Nedrysoft { namespace Ribbon {
             auto updateStyleSheet(bool isDarkMode) -> void;
 
         private:
-            Nedrysoft::ThemeSupport::ThemeSupport *m_themeSupport;                 //! theme support instance
+            //! @cond
+
+            Nedrysoft::ThemeSupport::ThemeSupport *m_themeSupport;
+
+            //! @endcond
     };
 }}
 

diff --git a/src/RibbonComboBoxPlugin.h b/src/RibbonComboBoxPlugin.h
@@ -125,7 +125,11 @@ class RibbonComboBoxPlugin :
         void initialize(QDesignerFormEditorInterface *core) override;
 
     private:
-        bool m_initialized = false;                         //! holds whether designer has initialised the factory yet
+        //! @cond
+
+        bool m_initialized = false;
+
+        //! @endcond
 };
 
 #endif // NEDRYSOFT_RIBBONCOMBOBOXPLUGIN_H
diff --git a/src/RibbonDropButton.h b/src/RibbonDropButton.h
@@ -50,9 +50,13 @@ namespace Nedrysoft { namespace Ribbon {
         private:
             Q_OBJECT
 
+            //! @cond
+
             Q_PROPERTY(QIcon icon READ icon WRITE setIcon)
             Q_PROPERTY(QSize iconSize READ iconSize WRITE setIconSize)
 
+            //! @endcond
+
         public:
             /**
              * @brief       Constructs a new RibbonDropButton which is a child of the parent.
@@ -116,11 +120,15 @@ namespace Nedrysoft { namespace Ribbon {
             Q_SIGNAL void clicked(bool dropdown);
 
         private:
-            QVBoxLayout *m_layout;                              //! the layout for this widget
-            QPushButton *m_mainButton;                          //! the main button
-            QPushButton *m_dropButton;                          //! the drop down button
-            QSize m_iconSize;                                   //! the size of the icon
-            Nedrysoft::ThemeSupport::ThemeSupport *m_themeSupport;     //! theme support instance
+            //! @cond
+
+            QVBoxLayout *m_layout;
+            QPushButton *m_mainButton;
+            QPushButton *m_dropButton;
+            QSize m_iconSize;
+            Nedrysoft::ThemeSupport::ThemeSupport *m_themeSupport;
+
+            //! @endcond
     };
 }}
 

diff --git a/src/RibbonDropButtonPlugin.h b/src/RibbonDropButtonPlugin.h
@@ -124,7 +124,11 @@ class RibbonDropButtonPlugin :
         void initialize(QDesignerFormEditorInterface *core) override;
 
     private:
-        bool m_initialized = false;                         //! holds whether designer has initialised the factory yet
+        //! @cond
+
+        bool m_initialized = false;
+
+        //! @endcond
 };
 
 #endif // NEDRYSOFT_RIBBONDROPBUTTONPLUGIN_H
diff --git a/src/RibbonFontManager.h b/src/RibbonFontManager.h
@@ -79,8 +79,12 @@ namespace Nedrysoft { namespace Ribbon {
             auto boldFont() -> QString const;
 
         private:
-            int m_regularFontId;                                                //! Regular font id after loading
-            int m_boldFontId;                                                   //! Bold font id after loading
+            //! @cond
+
+            int m_regularFontId;
+            int m_boldFontId;
+
+            //! @endcond
     };
 }}
 

diff --git a/src/RibbonGroup.h b/src/RibbonGroup.h
@@ -52,8 +52,12 @@ namespace Nedrysoft { namespace Ribbon {
         private:
             Q_OBJECT
 
+            //! @cond
+
             Q_PROPERTY(QString groupName READ groupName WRITE setGroupName)
 
+            //! @endcond
+
         public:
             /**
              * @brief       Constructs a new RibbonGroup which is a child of the parent.
@@ -97,10 +101,14 @@ namespace Nedrysoft { namespace Ribbon {
             auto event(QEvent *event) -> bool override;
 
         private:
-            QString m_groupName;                                    //! Group name that is displayed
-            QFont m_font;                                           //! Font used to draw the group name
-            QFontMetrics m_fontMetrics;                             //! The font metrics of the selected font
-            QRect m_textRect;                                       //! The rectangle of the group name in the selected font
+            //! @cond
+
+            QString m_groupName;
+            QFont m_font;
+            QFontMetrics m_fontMetrics;
+            QRect m_textRect;
+
+            //! @endcond
     };
 }}
 

diff --git a/src/RibbonGroupPlugin.h b/src/RibbonGroupPlugin.h
@@ -124,7 +124,11 @@ class RibbonGroupPlugin :
         void initialize(QDesignerFormEditorInterface *core) override;
 
     private:
-        bool m_initialized = false;                         //! holds whether designer has initialised the factory yet
+        //! @cond
+
+        bool m_initialized = false;
+
+        //! @endcond
 };
 
 #endif // NEDRYSOFT_RIBBONGROUPPLUGIN_H
diff --git a/src/RibbonLineEdit.h b/src/RibbonLineEdit.h
@@ -58,7 +58,7 @@ namespace Nedrysoft { namespace Ribbon {
             /**
              * @brief       Reimplements QWidget::setMinimumHeight(int minimumHeight)
              *
-             * @note        This hides the superclasses implemention as the ribbon line edit has a fixed height and
+             * @note        This hides the superclasses implementation as the ribbon line edit has a fixed height and
              *              we ignore any attempts to set it.
              *
              * @param[in]   minimumHeight the minimum height for the widget.
@@ -68,10 +68,10 @@ namespace Nedrysoft { namespace Ribbon {
             /**
              * @brief       Reimplements QWidget::setMaximumHeight(int maximumHeight)
              *
-             * @note        This hides the superclasses implemention as the ribbon line edit has a fixed height and
+             * @note        This hides the superclasses implementation as the ribbon line edit has a fixed height and
              *              we ignore any attempts to set it.
              *
-             * @param[in]   minimumHeight the maximum height for the widget.
+             * @param[in]   maximumHeight the maximum height for the widget.
              */
             void setMaximumHeight(int maximumHeight);
 
@@ -109,7 +109,7 @@ namespace Nedrysoft { namespace Ribbon {
              *
              * @note        Used to discard enter + return keys.
              *
-             * @param[in[   event the event information.
+             * @param[in]   event the event information.
              *
              * @returns     true if event handled; otherwise false.
              */
@@ -132,7 +132,11 @@ namespace Nedrysoft { namespace Ribbon {
             auto updateStyleSheet(bool isDarkMode) -> void;
 
         private:
-            Nedrysoft::ThemeSupport::ThemeSupport *m_themeSupport;                 //! theme support instance
+            //! @cond
+
+            Nedrysoft::ThemeSupport::ThemeSupport *m_themeSupport;
+
+            //! @endcond
     };
 }}
 

diff --git a/src/RibbonLineEditPlugin.h b/src/RibbonLineEditPlugin.h
@@ -125,7 +125,11 @@ class RibbonLineEditPlugin :
         void initialize(QDesignerFormEditorInterface *core) override;
 
     private:
-        bool m_initialized = false;                         //! holds whether designer has initialised the factory yet
+        //! @cond
+
+        bool m_initialized = false;
+
+        //! @endcond
 };
 
 #endif // NEDRYSOFT_RIBBONLINEDITPLUGIN_H
diff --git a/src/RibbonPushButton.h b/src/RibbonPushButton.h
@@ -48,10 +48,14 @@ namespace Nedrysoft { namespace Ribbon {
         private:
             Q_OBJECT
 
+            //! @cond
+
             Q_PROPERTY(QIcon icon READ icon WRITE setIcon)
             Q_PROPERTY(QSize iconSize READ iconSize WRITE setIconSize)
             Q_PROPERTY(QString text READ text WRITE setText)
 
+            //! @endcond
+
         public:
             /**
              * @brief       Constructs a new RibbonPushButton instance which is a child of the parent.
@@ -139,11 +143,15 @@ namespace Nedrysoft { namespace Ribbon {
             auto eventFilter(QObject *object, QEvent *event) -> bool override;
 
         private:
-            QVBoxLayout *m_layout;                              //! the layout for this widget
-            QPushButton *m_mainButton;                          //! the main button
-            QLabel *m_buttonLabel;                              //! the main button label
-            QSize m_iconSize;                                   //! the size of the icon
-            Nedrysoft::ThemeSupport::ThemeSupport *m_themeSupport;     //! an instance of theme support
+            //! @cond
+
+            QVBoxLayout *m_layout;
+            QPushButton *m_mainButton;
+            QLabel *m_buttonLabel;
+            QSize m_iconSize;
+            Nedrysoft::ThemeSupport::ThemeSupport *m_themeSupport;
+
+            //! @endcond
     };
 }}
 

diff --git a/src/RibbonPushButtonPlugin.h b/src/RibbonPushButtonPlugin.h
@@ -125,7 +125,11 @@ class RibbonPushButtonPlugin :
         void initialize(QDesignerFormEditorInterface *core) override;
 
     private:
-        bool m_initialized = false;                         //! holds whether designer has initialised the factory yet
+        //! @cond
+
+        bool m_initialized = false;
+
+        //! @endcond
 };
 
 #endif // NEDRYSOFT_RIBBONPUSHBUTTONPLUGIN_H
diff --git a/src/RibbonSlider.h b/src/RibbonSlider.h
@@ -63,7 +63,11 @@ namespace Nedrysoft { namespace Ribbon {
             auto updateStyleSheet(bool isDarkMode) -> void;
 
         private:
-            Nedrysoft::ThemeSupport::ThemeSupport *m_themeSupport;                 //! theme support instance
+            //! @cond
+
+            Nedrysoft::ThemeSupport::ThemeSupport *m_themeSupport;
+
+            //! @endcond
     };
 }}
 

diff --git a/src/RibbonSliderPlugin.h b/src/RibbonSliderPlugin.h
@@ -125,7 +125,11 @@ class RibbonSliderPlugin :
         void initialize(QDesignerFormEditorInterface *core) override;
 
     private:
-        bool m_initialized = false;                         //! holds whether designer has initialised the factory yet
+        //! @cond
+
+        bool m_initialized = false;
+
+        //! @endcond
 };
 
 #endif // NEDRYSOFT_RIBBONSLIDERPLUGIN_H
diff --git a/src/RibbonTabBar.h b/src/RibbonTabBar.h
@@ -94,11 +94,15 @@ namespace Nedrysoft { namespace Ribbon {
             auto updateStyleSheet(bool isDarkMode) -> void;
 
         private:
-            QFont m_selectedFont;                                   //! font to use on selected tab
-            QFont m_normalFont;                                     //! font to use on deselected tabs
-            bool m_mouseInWidget;                                   //! tracks whether the mouse is tracked inside the widget
+            //! @cond
 
-            Nedrysoft::ThemeSupport::ThemeSupport *m_themeSupport;         //! theme support instance
+            QFont m_selectedFont;
+            QFont m_normalFont;
+            bool m_mouseInWidget;
+
+            Nedrysoft::ThemeSupport::ThemeSupport *m_themeSupport;
+
+            //! @endcond
     };
 }}
 

diff --git a/src/RibbonToolButton.h b/src/RibbonToolButton.h
@@ -63,7 +63,11 @@ namespace Nedrysoft { namespace Ribbon {
             auto updateStyleSheet(bool isDarkMode) -> void;
 
         private:
-            Nedrysoft::ThemeSupport::ThemeSupport *m_themeSupport;     //! an instance of theme support
+            //! @cond
+
+            Nedrysoft::ThemeSupport::ThemeSupport *m_themeSupport;
+
+            //! @endcond
     };
 }}
 

diff --git a/src/RibbonToolButtonPlugin.h b/src/RibbonToolButtonPlugin.h
@@ -125,7 +125,11 @@ class RibbonToolButtonPlugin :
         void initialize(QDesignerFormEditorInterface *core) override;
 
     private:
-        bool m_initialized = false;                         //! holds whether designer has initialised the factory yet
+        //! @cond
+
+        bool m_initialized = false;
+
+        //! @endcond
 };
 
 #endif // NEDRYSOFT_RIBBONTOOLBUTTONPLUGIN_H