Improved doxygen (#275)

Signed-off-by: ahcorde <[email protected]>

.github/workflows/ci.yml

@@ -14,6 +14,7 @@ jobs:
         uses: ignition-tooling/action-ignition-ci@bionic
         with:
           codecov-enabled: true
+          doxygen-enabled: true
   focal-ci:
     runs-on: ubuntu-latest
     name: Ubuntu Focal CI

CMakeLists.txt

@@ -108,12 +108,13 @@ ign_create_docs(
   API_MAINPAGE_MD "${CMAKE_BINARY_DIR}/api.md"
   TUTORIALS_MAINPAGE_MD "${CMAKE_BINARY_DIR}/tutorials.md"
   ADDITIONAL_INPUT_DIRS "${CMAKE_SOURCE_DIR}/src/plugins"
+  IMAGE_PATH_DIRS "${CMAKE_SOURCE_DIR}/tutorials/images"
   TAGFILES
-  "\"${CMAKE_SOURCE_DIR}/doc/qt.tag.xml=http://doc.qt.io/qt-5/\" \
-   \"${IGNITION-MATH_DOXYGEN_TAGFILE} = ${IGNITION-MATH_API_URL}\" \
-   \"${IGNITION-MSGS_DOXYGEN_TAGFILE} = ${IGNITION-MSGS_API_URL}\" \
-   \"${IGNITION-TRANSPORT_DOXYGEN_TAGFILE} = ${IGNITION-TRANSPORT_API_URL}\" \
-   \"${IGNITION-COMMON_DOXYGEN_TAGFILE} = ${IGNITION-COMMON_API_URL}\""
-  )
+    "${CMAKE_SOURCE_DIR}/doc/qt.tag.xml=http://doc.qt.io/qt-5/"
+    "${IGNITION-MATH_DOXYGEN_TAGFILE} = ${IGNITION-MATH_API_URL}"
+    "${IGNITION-MSGS_DOXYGEN_TAGFILE} = ${IGNITION-MSGS_API_URL}"
+    "${IGNITION-TRANSPORT_DOXYGEN_TAGFILE} = ${IGNITION-TRANSPORT_API_URL}"
+    "${IGNITION-COMMON_DOXYGEN_TAGFILE} = ${IGNITION-COMMON_API_URL}"
+)
 
 file(COPY ${CMAKE_SOURCE_DIR}/tutorials/images/ DESTINATION ${CMAKE_BINARY_DIR}/doxygen/html/images/)

include/ignition/gui/Application.hh

@@ -96,11 +96,11 @@ namespace ignition
       /// and plugins. This function doesn't instantiate the plugins, it just
       /// keeps them in memory and they can be applied later by either
       /// instantiating a window or several dialogs.
-      /// \param[in] _config Full path to configuration file.
+      /// \param[in] _path Full path to configuration file.
       /// \return True if successful
       /// \sa InitializeMainWindow
       /// \sa InitializeDialogs
-      public: bool LoadConfig(const std::string &_config);
+      public: bool LoadConfig(const std::string &_path);
 
       /// \brief Load the configuration from the default config file.
       /// \return True if successful

include/ignition/gui/GuiEvents.hh

@@ -103,7 +103,7 @@ namespace ignition
       class SpawnFromDescription : public QEvent
       {
         /// \brief Constructor
-        /// \param[in] _string The resource's description as a string, such
+        /// \param[in] _description The resource's description as a string, such
         /// as an SDF file.
         public: explicit SpawnFromDescription(const std::string &_description)
             : QEvent(kType), description(_description)

include/ignition/gui/Plugin.hh

@@ -102,7 +102,10 @@ namespace ignition
       /// \sa Load
       /// \param[in] _pluginElem Element containing configuration
       protected: virtual void LoadConfig(
-          const tinyxml2::XMLElement * /*_pluginElem*/) {}
+          const tinyxml2::XMLElement *_pluginElem)
+          {
+            (void)_pluginElem;
+          }
 
       /// \brief Get title
       /// \return Plugin title.

src/plugins/key_publisher/KeyPublisher.hh

@@ -46,7 +46,8 @@ namespace gui
     public: virtual ~KeyPublisher();
 
     // Documentation inherited
-    public: virtual void LoadConfig(const tinyxml2::XMLElement *) override;
+    public: virtual void LoadConfig(
+      const tinyxml2::XMLElement *_pluginElem) override;
 
     /// \brief Filter events in Qt
     /// \param[in] _obj The watched object

tutorials/03_plugins.md

@@ -48,11 +48,11 @@ Publish messages on an Ignition Transport topic.
 
         ign topic -e -t /echo
 
-1. On a new terminal, open the publisher GUI:
+2. On a new terminal, open the publisher GUI:
 
         ign gui -s Publisher
 
-1. The GUI is pre-filled to publish "Hello" messages on the `/echo` topic.
+3. The GUI is pre-filled to publish "Hello" messages on the `/echo` topic.
    Click "Publish" to publish a message and see it on the terminal.
 
 ### World stats and control
@@ -101,7 +101,7 @@ plugins.
 
     ign gui -c examples/config/reqres.config
 
-### Displays {#display-plugins}
+### Displays
 
 **Not ported to versions 1 or higher yet**
 
@@ -119,5 +119,5 @@ Ignition GUI will look for display plugins on the following paths, in this
 order:
 
 1. All paths set on the `IGN_GUI_DISPLAY_PLUGIN_PATH` environment variable
-1. `~/.ignition/gui/display_plugins`
-1. [Display plugins that are installed with Ignition GUI](https://ignitionrobotics.org/api/gui/0.1/namespaceignition_1_1gui_1_1display_plugins.html)
+2. `~/.ignition/gui/display_plugins`
+3. [Display plugins that are installed with Ignition GUI](https://ignitionrobotics.org/api/gui/0.1/namespaceignition_1_1gui_1_1display_plugins.html)