fix doxygen warnings and tags

CHANGELOG.md

@@ -10,23 +10,26 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [vNext] - unreleased
 
 **Added**
+- added containerization for development by using devcontainer
+- added continuous integration on Github Actions
+- added automatic dependency updates on the Github Action workflows using dependabot
 - added .clang-format and applied formatting
 - added .clang-tidy and applied basic rule set
 - added CPPLINT.cfg files to the source tree for configuration and exlusion of files from cpplint runs
 - added cpplint.sh, format.sh, tidy.sh to build-tools to reliably run C++ QA tools
-- vcpkg is used for dependency management
-- make vcpkg.json the source for the version number
-- add show_build_target_properties to cmakelists
-- switch from include_directories() to target_include_directories()
-- CMake namespaced aliases for core library and extensions, e.g.
+- added vcpkg for dependency management
+- added SetupVcpkg for automatic installation of vcpkg packages during CMake configure step
+- made vcpkg.json the single source for the version number and generate a version.hpp
+- add show_build_target_properties() to CMakeLists
+- added CMake namespaced aliases for core library and extensions, e.g.
   - fifechan::fifechan, fifechan::fifechan_sdl, etc.
 - reintegrated https://github.com/fifengine/fifechan-demos
-  - the examples are now in the `tests/integration` folder, ref. https://github.com/fifengine/fifechan/issues/37
-  - converted build scripts from autotools to cmake, closes https://github.com/fifengine/fifechan-demos/issues/1
+  - the examples are now in the `tests/integration` folder, https://github.com/fifengine/fifechan/issues/37
+  - converted build scripts from autotools to cmake, https://github.com/fifengine/fifechan-demos/issues/1
 - Prepped a `tests/unit` folder for someone inclined to work on unit tests.
 - added SDL2Graphics
-- added support for target and package config (find_package), closes https://github.com/fifengine/fifechan/issues/19
-- added pkg-config support to CMakeLists (for pkg-config), closes https://github.com/fifengine/fifechan/issues/19
+- added support for target and package config (find_package), https://github.com/fifengine/fifechan/issues/19
+- added pkg-config support to CMakeLists (for pkg-config), https://github.com/fifengine/fifechan/issues/19
 - added handling of conditional dependencies in exported CMake configs
   - this enables upstream project to retire their finder scripts (FindFifechan.cmake)
 
@@ -36,7 +39,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - moved each "unified header file" of a backend from the fifechan include folder ("include/fifechan")
   to the include folder of the backend itself
   - "include/fifechan/opengl.hpp" -> "include/fifechan/backends/opengl/opengl.hpp"
-- updated CMakeLists formatting
+- modernize CMakeList syntax and formatting, e.g. switch from include_directories() to target_include_directories(), etc.
 - modernised license headers and copyright notices using SPDX tags
 - FCN_CORE_DECLSPEC -> FIFEGUI_API & FCN_EXTENSION_DECLSPEC -> FIFEGUI_EXT_API
 - fix WIN32_LEAN_AND_MEAN redeclaration errors
@@ -50,6 +53,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - renamed variable carea to clip_rect
 - applied spellchecking
 - renamed function parameter recursiv to recursion
+- fixed all Doxygen warnings "found unknown command"
 
 **Removed**
 - removed backends: allegro, cairo, irrlicht, glut, hge, openlayer

include/fifechan.hpp

@@ -79,7 +79,7 @@
 #include "fifechan/version.hpp"
 
 /**
- * @brief Returns the version of the library.
+ * Returns the version of the library.
  *
  * @return the version.
  */

include/fifechan/event.hpp

@@ -12,7 +12,7 @@ namespace fcn
     class Widget;
 
     /**
-     * @brief Base class for all events in the GUI.
+     * Base class for all events in the GUI.
      * An event is a signal that something has happened in the GUI.
      * Events are used to notify widgets of user actions.
      * The event class is the base class for all events in the GUI.

include/fifechan/keyinput.hpp

@@ -147,7 +147,7 @@ namespace fcn
          *
          * @return True if key pressed at the numeric pad,
          *         false otherwise.
-         * @setNumericPad
+         * @see setNumericPad
          */
         bool isNumericPad() const;
 

include/fifechan/platform.hpp

@@ -32,7 +32,7 @@
 #endif
 
 /**
- * @brief Symbol Visibility
+ * Symbol Visibility
  *
  * This header defines macros for symbol visibility in the library.
  * The macros are used to define whether a symbol should be exported or imported.

include/fifechan/text.hpp

@@ -95,7 +95,7 @@ namespace fcn
         /**
          * Inserts a character at the current caret position.
          *
-         * @parameter character The character to insert.
+         * @param character The character to insert.
          */
         virtual void insert(int character);
 

include/fifechan/widget.hpp

@@ -1380,39 +1380,34 @@ namespace fcn
             return false;
         }
 
+
         void getLastPosition(int& x, int& y) const;
         void setLastPosition(int x, int y);
         bool isLastPositionSet() const;
 
     protected:
         /**
-         * Distributes an action event to all action listeners
-         * of the widget.
-         *
+         * Distributes an action event to all action listeners of the widget.
          */
         void distributeActionEvent();
 
         /**
          * Distributes resized events to all of the widget's listeners.
-         *
          */
         void distributeResizedEvent();
 
         /**
          * Distributes moved events to all of the widget's listeners.
-         *
          */
         void distributeMovedEvent();
 
         /**
          * Distributes hidden events to all of the widget's listeners.
-         *
          */
         void distributeHiddenEvent();
 
         /**
          * Distributes shown events to all of the widget's listeners.
-         *
          */
         void distributeShownEvent();
 
@@ -1738,6 +1733,9 @@ namespace fcn
          */
         static VisibilityEventHandler* mVisibilityEventHandler;
 
+        /**
+         * Holds the death listener used by the widgets.
+         */
         static DeathListener* mGuiDeathListener;
 
         /**

include/fifechan/widgetlistener.hpp

@@ -57,7 +57,7 @@ namespace fcn
         /**
          * Invoked when an ancestor of a widget is moved.
          *
-         * @Param event Describes the event.
+         * @param event Describes the event.
          */
         virtual void ancestorMoved(Event const & event) { }
 

include/fifechan/widgets/adjustingcontainer.hpp

@@ -19,15 +19,15 @@ namespace fcn
      *
      * The user specifies
      *
-     * @verbitam
+     * @verbatim
      * <ul>
      *   <li>the number of columns</li>
      *   <li>horizontal spacing between columns</li>
      *   <li>vertical spacing between rows</li>
      *   <li>padding around the sides of the container</li>
      *   <li>each column's alignment</li>
      * </ul>
-     * @endverbitam
+     * @endverbatim
      *
      * These properties give the user a lot of flexibility to make the
      * widgets look just right.
@@ -56,7 +56,7 @@ namespace fcn
      * @endcode
      *
      * Output:
-     * @verbitam
+     * @verbatim
      * <pre>
      *+---------------------------------------------------------------------------+
      *|                                                                           |
@@ -68,7 +68,8 @@ namespace fcn
      *|                                                                           |
      *+---------------------------------------------------------------------------+
      * </pre>
-     * @endverbitam
+     * @endverbatim
+     *
      * As you can see, each column is only as big as its largest element.
      * The AdjustingContainer will resize itself and rearrange its contents
      * based on whatever widgets it contains, allowing dynamic addition and

include/fifechan/widgets/bargraph.hpp

@@ -16,20 +16,68 @@ namespace fcn
     {
     public:
         BarGraph();
+
+        /**
+         * Constructor.
+         */
         BarGraph(int x, int y, int w, int h);
 
         virtual ~BarGraph() { }
 
+        /**
+         * Sets the x position of the bar.
+         */
         void setBarX(int x);
+
+        /**
+         * @return The x position of the bar.
+         */
         int getBarX() const;
+
+        /**
+         * Sets the y position of the bar.
+         */
         void setBarY(int y);
+
+        /**
+         * @return The y position of the bar.
+         */
         int getBarY() const;
+
+        /**
+         * Sets the position of the bar.
+         */
         void setBarPosition(int x, int y);
+
+        /**
+         * @return The position of the bar.
+         */
         void setBarPosition(Point const & pos);
+
+        /**
+         * Sets the width of the bar.
+         */
         void setBarWidth(int w);
+
+        /**
+         * @return The width of the bar.
+         */
         int getBarWidth() const;
+
+        /**
+         * Sets the height of the bar.
+         */
+
         void setBarHeight(int h);
+
+        /**
+         * @return The height of the bar.
+         */
         int getBarHeight() const;
+
+        /**
+         * Sets the size of the bar.
+         */
         void setBarSize(int w, int h);
 
         /**
@@ -50,7 +98,14 @@ namespace fcn
         virtual void draw(Graphics* graphics);
 
     protected:
+        /**
+         * m_opaque is true if the graph is opaque, false otherwise.
+         */
         bool m_opaque;
+
+        /**
+         * m_rec is the rectangle that represents the bar.
+         */
         Rectangle m_rec;
     };
 }; // namespace fcn

include/fifechan/widgets/container.hpp

@@ -26,6 +26,9 @@ namespace fcn
     class FIFEGUI_API Container : public Widget
     {
     public:
+        /**
+         * The layout policy of the container.
+         */
         enum LayoutPolicy
         {
             Absolute,