From 5ce2aaf838cafb9e3118ee1f2d74819b2044dd22 Mon Sep 17 00:00:00 2001 From: ahcorde Date: Thu, 26 Aug 2021 12:28:46 +0200 Subject: [PATCH 1/4] Fixed doxygen Signed-off-by: ahcorde --- .github/workflows/ci.yml | 1 + CMakeLists.txt | 13 +++++++------ include/ignition/gui/Application.hh | 4 ++-- include/ignition/gui/GuiEvents.hh | 2 +- include/ignition/gui/Plugin.hh | 5 ++++- src/plugins/key_publisher/KeyPublisher.hh | 3 ++- 6 files changed, 17 insertions(+), 11 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index e36175c3a..53e67b817 100644 --- a/.github/workflows/ci.yml +++ b/.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 diff --git a/CMakeLists.txt b/CMakeLists.txt index 188d7f061..49d2f90b9 100644 --- a/CMakeLists.txt +++ b/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/) diff --git a/include/ignition/gui/Application.hh b/include/ignition/gui/Application.hh index cf8f170d9..4b176fd98 100644 --- a/include/ignition/gui/Application.hh +++ b/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] _pluginElem 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 &_pluginElem); /// \brief Load the configuration from the default config file. /// \return True if successful diff --git a/include/ignition/gui/GuiEvents.hh b/include/ignition/gui/GuiEvents.hh index 8ef8ea819..78f8a0cbf 100644 --- a/include/ignition/gui/GuiEvents.hh +++ b/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) diff --git a/include/ignition/gui/Plugin.hh b/include/ignition/gui/Plugin.hh index 07c69d600..b943b1e0d 100644 --- a/include/ignition/gui/Plugin.hh +++ b/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. diff --git a/src/plugins/key_publisher/KeyPublisher.hh b/src/plugins/key_publisher/KeyPublisher.hh index 759248882..38ecdd2e5 100644 --- a/src/plugins/key_publisher/KeyPublisher.hh +++ b/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 From 9c0aacfd828cdf5177badc32a0ef98dfad2f1e77 Mon Sep 17 00:00:00 2001 From: ahcorde Date: Tue, 14 Sep 2021 12:44:58 +0200 Subject: [PATCH 2/4] Fixed doxygen Signed-off-by: ahcorde --- tutorials/03_plugins.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/tutorials/03_plugins.md b/tutorials/03_plugins.md index 15a4df333..8edb14325 100644 --- a/tutorials/03_plugins.md +++ b/tutorials/03_plugins.md @@ -118,6 +118,6 @@ Ignition GUI by default. 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) + - All paths set on the `IGN_GUI_DISPLAY_PLUGIN_PATH` environment variable + - `~/.ignition/gui/display_plugins` + - [Display plugins that are installed with Ignition GUI](https://ignitionrobotics.org/api/gui/0.1/namespaceignition_1_1gui_1_1display_plugins.html) From d9c78efce068db6c85cfa37d3fcadfae9ac29a24 Mon Sep 17 00:00:00 2001 From: ahcorde Date: Tue, 14 Sep 2021 12:51:17 +0200 Subject: [PATCH 3/4] Fixed doxygen Signed-off-by: ahcorde --- tutorials/03_plugins.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/tutorials/03_plugins.md b/tutorials/03_plugins.md index 8edb14325..d25799305 100644 --- a/tutorials/03_plugins.md +++ b/tutorials/03_plugins.md @@ -101,7 +101,7 @@ plugins. ign gui -c examples/config/reqres.config -### Displays {#display-plugins} +### Displays **Not ported to versions 1 or higher yet** @@ -118,6 +118,6 @@ Ignition GUI by default. Ignition GUI will look for display plugins on the following paths, in this order: - - All paths set on the `IGN_GUI_DISPLAY_PLUGIN_PATH` environment variable - - `~/.ignition/gui/display_plugins` - - [Display plugins that are installed with Ignition GUI](https://ignitionrobotics.org/api/gui/0.1/namespaceignition_1_1gui_1_1display_plugins.html) +1. All paths set on the `IGN_GUI_DISPLAY_PLUGIN_PATH` environment variable +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) From 269471fe0da747aa0003a4f92a95a4312cb5da14 Mon Sep 17 00:00:00 2001 From: ahcorde Date: Thu, 23 Sep 2021 09:33:20 +0200 Subject: [PATCH 4/4] Feedback Signed-off-by: ahcorde --- include/ignition/gui/Application.hh | 4 ++-- tutorials/03_plugins.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/include/ignition/gui/Application.hh b/include/ignition/gui/Application.hh index 4b176fd98..b0813a8fc 100644 --- a/include/ignition/gui/Application.hh +++ b/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] _pluginElem 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 &_pluginElem); + public: bool LoadConfig(const std::string &_path); /// \brief Load the configuration from the default config file. /// \return True if successful diff --git a/tutorials/03_plugins.md b/tutorials/03_plugins.md index d25799305..53ced108c 100644 --- a/tutorials/03_plugins.md +++ b/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