From 511743c5638857a37a4b1cad1f9b6e64785e92a4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dietrich=20Kr=C3=B6nke?= Date: Fri, 1 Apr 2022 12:46:26 +0200 Subject: [PATCH 1/4] iox-#1311 Set version number to 2.0.1 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Create changelog for v2.0.1 Signed-off-by: Dietrich Krönke --- VERSION | 2 +- cmake/package/package.cmake | 2 +- doc/aspice_swe3_4/CMakeLists.txt | 2 +- doc/website/release-notes/iceoryx-v2-0-1.md | 10 ++++++++++ iceoryx_binding_c/CMakeLists.txt | 2 +- iceoryx_binding_c/package.xml | 2 +- iceoryx_dds/CMakeLists.txt | 2 +- iceoryx_hoofs/CMakeLists.txt | 2 +- iceoryx_hoofs/package.xml | 2 +- iceoryx_integrationtest/package.xml | 2 +- iceoryx_posh/CMakeLists.txt | 2 +- iceoryx_posh/package.xml | 2 +- tools/introspection/CMakeLists.txt | 2 +- 13 files changed, 22 insertions(+), 12 deletions(-) create mode 100644 doc/website/release-notes/iceoryx-v2-0-1.md diff --git a/VERSION b/VERSION index 227cea2156..38f77a65b3 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -2.0.0 +2.0.1 diff --git a/cmake/package/package.cmake b/cmake/package/package.cmake index e6f8bb1432..c9e9c75fd2 100644 --- a/cmake/package/package.cmake +++ b/cmake/package/package.cmake @@ -14,7 +14,7 @@ # # SPDX-License-Identifier: Apache-2.0 cmake_minimum_required(VERSION 3.16) -set(IOX_VERSION_STRING "2.0.0") +set(IOX_VERSION_STRING "2.0.1") project(iceoryx_package VERSION ${IOX_VERSION_STRING}) diff --git a/doc/aspice_swe3_4/CMakeLists.txt b/doc/aspice_swe3_4/CMakeLists.txt index 53bbb01d27..9a0e99de8e 100644 --- a/doc/aspice_swe3_4/CMakeLists.txt +++ b/doc/aspice_swe3_4/CMakeLists.txt @@ -16,7 +16,7 @@ cmake_minimum_required(VERSION 3.16) -set(IOX_VERSION_STRING "2.0.0") +set(IOX_VERSION_STRING "2.0.1") project(iceoryx_doc VERSION ${IOX_VERSION_STRING}) diff --git a/doc/website/release-notes/iceoryx-v2-0-1.md b/doc/website/release-notes/iceoryx-v2-0-1.md new file mode 100644 index 0000000000..6fd89405cb --- /dev/null +++ b/doc/website/release-notes/iceoryx-v2-0-1.md @@ -0,0 +1,10 @@ +# iceoryx v2.0.1 + +## [v2.0.1](https://github.com/eclipse-iceoryx/iceoryx/tree/v2.0.1) (2022-04-01) + +[Full Changelog](https://github.com/eclipse-iceoryx/iceoryx/compare/v2.0.0...v2.0.1) + +**Bugfixes:** + +- CMake warning: empty command-line option [\#1311](https://github.com/eclipse-iceoryx/iceoryx/issues/1311) thanks to @clalancette +- iox-#743 Fixes to make docs exportable [\#1289](https://github.com/eclipse-iceoryx/iceoryx/pull/1289) diff --git a/iceoryx_binding_c/CMakeLists.txt b/iceoryx_binding_c/CMakeLists.txt index db4cdd2b0b..d2ea382cb3 100644 --- a/iceoryx_binding_c/CMakeLists.txt +++ b/iceoryx_binding_c/CMakeLists.txt @@ -16,7 +16,7 @@ # SPDX-License-Identifier: Apache-2.0 cmake_minimum_required(VERSION 3.16) -set(IOX_VERSION_STRING "2.0.0") +set(IOX_VERSION_STRING "2.0.1") diff --git a/iceoryx_binding_c/package.xml b/iceoryx_binding_c/package.xml index 31dee3adbd..2a1e73d210 100644 --- a/iceoryx_binding_c/package.xml +++ b/iceoryx_binding_c/package.xml @@ -2,7 +2,7 @@ iceoryx_binding_c - 2.0.0 + 2.0.1 Eclipse iceoryx inter-process-communication (IPC) middleware C-Language Binding Eclipse Foundation, Inc. Apache 2.0 diff --git a/iceoryx_dds/CMakeLists.txt b/iceoryx_dds/CMakeLists.txt index 7b6c4f0c33..ca96b2d950 100644 --- a/iceoryx_dds/CMakeLists.txt +++ b/iceoryx_dds/CMakeLists.txt @@ -16,7 +16,7 @@ # SPDX-License-Identifier: Apache-2.0 cmake_minimum_required(VERSION 3.16) -set(IOX_VERSION_STRING "2.0.0") +set(IOX_VERSION_STRING "2.0.1") project(iceoryx_dds VERSION ${IOX_VERSION_STRING}) diff --git a/iceoryx_hoofs/CMakeLists.txt b/iceoryx_hoofs/CMakeLists.txt index a0ba120e74..1765dec8a1 100644 --- a/iceoryx_hoofs/CMakeLists.txt +++ b/iceoryx_hoofs/CMakeLists.txt @@ -17,7 +17,7 @@ cmake_minimum_required(VERSION 3.16) -set(IOX_VERSION_STRING "2.0.0") +set(IOX_VERSION_STRING "2.0.1") project(iceoryx_hoofs VERSION ${IOX_VERSION_STRING}) diff --git a/iceoryx_hoofs/package.xml b/iceoryx_hoofs/package.xml index 59f7876eb9..89bf20dd5e 100644 --- a/iceoryx_hoofs/package.xml +++ b/iceoryx_hoofs/package.xml @@ -2,7 +2,7 @@ iceoryx_hoofs - 2.0.0 + 2.0.1 Eclipse iceoryx inter-process-communication (IPC) middleware basic building blocks Eclipse Foundation, Inc. Apache 2.0 diff --git a/iceoryx_integrationtest/package.xml b/iceoryx_integrationtest/package.xml index 81fe28f080..bdd5611d79 100644 --- a/iceoryx_integrationtest/package.xml +++ b/iceoryx_integrationtest/package.xml @@ -2,7 +2,7 @@ iceoryx_integrationtest - 2.0.0 + 2.0.1 iceoryx Software Integrationtest Eclipse Foundation, Inc. Apache 2.0 diff --git a/iceoryx_posh/CMakeLists.txt b/iceoryx_posh/CMakeLists.txt index 8f28ac07bf..63ba37b08a 100644 --- a/iceoryx_posh/CMakeLists.txt +++ b/iceoryx_posh/CMakeLists.txt @@ -16,7 +16,7 @@ # SPDX-License-Identifier: Apache-2.0 cmake_minimum_required(VERSION 3.16) -set(IOX_VERSION_STRING "2.0.0") +set(IOX_VERSION_STRING "2.0.1") project(iceoryx_posh VERSION ${IOX_VERSION_STRING}) diff --git a/iceoryx_posh/package.xml b/iceoryx_posh/package.xml index d71ed6102c..fce76dae26 100644 --- a/iceoryx_posh/package.xml +++ b/iceoryx_posh/package.xml @@ -2,7 +2,7 @@ iceoryx_posh - 2.0.0 + 2.0.1 Eclipse iceoryx inter-process-communication (IPC) middleware Posix Shared Memory Library and middleware daemon (RouDi) Eclipse Foundation, Inc. Apache 2.0 diff --git a/tools/introspection/CMakeLists.txt b/tools/introspection/CMakeLists.txt index 8946e16c94..1ffa54690f 100644 --- a/tools/introspection/CMakeLists.txt +++ b/tools/introspection/CMakeLists.txt @@ -17,7 +17,7 @@ cmake_minimum_required(VERSION 3.16) -set(IOX_VERSION_STRING "2.0.0") +set(IOX_VERSION_STRING "2.0.1") project(iceoryx_introspection VERSION ${IOX_VERSION_STRING}) From 71d3da79936563a378134ccf3ca142dc67daed5c Mon Sep 17 00:00:00 2001 From: Mathias Kraus Date: Fri, 1 Apr 2022 15:43:56 +0200 Subject: [PATCH 2/4] iox-#1293 Include additional header into generated doxygen documentation --- doc/aspice_swe3_4/CMakeLists.txt | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/doc/aspice_swe3_4/CMakeLists.txt b/doc/aspice_swe3_4/CMakeLists.txt index 9a0e99de8e..df4c6b05b9 100644 --- a/doc/aspice_swe3_4/CMakeLists.txt +++ b/doc/aspice_swe3_4/CMakeLists.txt @@ -26,6 +26,7 @@ set(DOXYGEN_GENERATE_HTML YES) set(DOXYGEN_GENERATE_LATEX YES) set(DOXYGEN_GENERATE_XML YES) set(DOXYGEN_XML_OUTPUT xml) +# if some header need to be excluded from the exclude pattern have a look at INCLUDE_DIR_AND_ADDITIONAL_FILES below set(DOXYGEN_EXCLUDE_PATTERNS "*/internal/*") set(DOXYGEN_EXCLUDE_SYMBOLS "internal::*") @@ -76,8 +77,26 @@ foreach(val RANGE ${cmp_len}) set(DOXYGEN_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/doc/${cmp}) + set(INCLUDE_DIR_AND_ADDITIONAL_FILES ${cmp_dir}/include) + if(${cmp} STREQUAL iceoryx_posh) + list(APPEND INCLUDE_DIR_AND_ADDITIONAL_FILES + ${cmp_dir}/include/iceoryx_posh/internal/popo/base_client.hpp + ${cmp_dir}/include/iceoryx_posh/internal/popo/base_publisher.hpp + ${cmp_dir}/include/iceoryx_posh/internal/popo/base_server.hpp + ${cmp_dir}/include/iceoryx_posh/internal/popo/base_subscriber.hpp + ${cmp_dir}/include/iceoryx_posh/internal/popo/client_impl.hpp + ${cmp_dir}/include/iceoryx_posh/internal/popo/publisher_impl.hpp + ${cmp_dir}/include/iceoryx_posh/internal/popo/server_impl.hpp + ${cmp_dir}/include/iceoryx_posh/internal/popo/subscriber_impl.hpp + ${cmp_dir}/include/iceoryx_posh/internal/popo/untyped_client_impl.hpp + ${cmp_dir}/include/iceoryx_posh/internal/popo/untyped_publisher_impl.hpp + ${cmp_dir}/include/iceoryx_posh/internal/popo/untyped_server_impl.hpp + ${cmp_dir}/include/iceoryx_posh/internal/popo/untyped_subscriber_impl.hpp + ) + endif() + doxygen_add_docs(doxygen_${cmp} - ${cmp_dir}/include + ${INCLUDE_DIR_AND_ADDITIONAL_FILES} WORKING_DIRECTORY ${cmp_dir}/include ALL) endforeach() From ba1cd319e64c280b1fd686a35fc5f76253e3d883 Mon Sep 17 00:00:00 2001 From: Mathias Kraus Date: Fri, 1 Apr 2022 15:55:56 +0200 Subject: [PATCH 3/4] iox-#1293 Add note for internal header which are generated with the doxygen documentation --- iceoryx_posh/include/iceoryx_posh/internal/popo/base_client.hpp | 1 + .../include/iceoryx_posh/internal/popo/base_publisher.hpp | 1 + iceoryx_posh/include/iceoryx_posh/internal/popo/base_server.hpp | 1 + .../include/iceoryx_posh/internal/popo/base_subscriber.hpp | 1 + iceoryx_posh/include/iceoryx_posh/internal/popo/client_impl.hpp | 2 ++ .../include/iceoryx_posh/internal/popo/publisher_impl.hpp | 2 ++ iceoryx_posh/include/iceoryx_posh/internal/popo/server_impl.hpp | 2 ++ .../include/iceoryx_posh/internal/popo/subscriber_impl.hpp | 2 ++ .../include/iceoryx_posh/internal/popo/untyped_client_impl.hpp | 2 ++ .../iceoryx_posh/internal/popo/untyped_publisher_impl.hpp | 2 ++ .../include/iceoryx_posh/internal/popo/untyped_server_impl.hpp | 2 ++ .../iceoryx_posh/internal/popo/untyped_subscriber_impl.hpp | 2 ++ 12 files changed, 20 insertions(+) diff --git a/iceoryx_posh/include/iceoryx_posh/internal/popo/base_client.hpp b/iceoryx_posh/include/iceoryx_posh/internal/popo/base_client.hpp index 9c4fc49308..ef3643b640 100644 --- a/iceoryx_posh/include/iceoryx_posh/internal/popo/base_client.hpp +++ b/iceoryx_posh/include/iceoryx_posh/internal/popo/base_client.hpp @@ -34,6 +34,7 @@ using uid_t = UniquePortId; /// @brief The BaseClient class contains the common implementation for the different clients /// @param[in] PortT type of the underlying port, required for testing /// @param[in] TriggerHandleT type of the underlying trigger handle, required for testing +/// @note Not intended for public usage! Use the `Client` or `UntypedClient` instead! template class BaseClient { diff --git a/iceoryx_posh/include/iceoryx_posh/internal/popo/base_publisher.hpp b/iceoryx_posh/include/iceoryx_posh/internal/popo/base_publisher.hpp index b2c27e44a6..77a3bafdaf 100644 --- a/iceoryx_posh/include/iceoryx_posh/internal/popo/base_publisher.hpp +++ b/iceoryx_posh/include/iceoryx_posh/internal/popo/base_publisher.hpp @@ -33,6 +33,7 @@ using uid_t = UniquePortId; /// /// @brief The BasePublisher class contains the common implementation for the different publisher specializations. +/// @note Not intended for public usage! Use the `Publisher` or `UntypedPublisher` instead! /// template class BasePublisher diff --git a/iceoryx_posh/include/iceoryx_posh/internal/popo/base_server.hpp b/iceoryx_posh/include/iceoryx_posh/internal/popo/base_server.hpp index 176bb556a8..a36fadd364 100644 --- a/iceoryx_posh/include/iceoryx_posh/internal/popo/base_server.hpp +++ b/iceoryx_posh/include/iceoryx_posh/internal/popo/base_server.hpp @@ -34,6 +34,7 @@ using uid_t = UniquePortId; /// @brief The BaseServer class contains the common implementation for the different server /// @param[in] PortT type of the underlying port, required for testing specializations. /// @param[in] TriggerHandleT type of the underlying trigger handle, required for testing +/// @note Not intended for public usage! Use the `Server` or `UntypedServer` instead! template class BaseServer { diff --git a/iceoryx_posh/include/iceoryx_posh/internal/popo/base_subscriber.hpp b/iceoryx_posh/include/iceoryx_posh/internal/popo/base_subscriber.hpp index feb1b55078..e1cff1b6e1 100644 --- a/iceoryx_posh/include/iceoryx_posh/internal/popo/base_subscriber.hpp +++ b/iceoryx_posh/include/iceoryx_posh/internal/popo/base_subscriber.hpp @@ -50,6 +50,7 @@ enum class SubscriberState : StateEnumIdentifier /// @brief base class for all types of subscriber /// @param[in] port_t type of the underlying port, required for testing +/// @note Not intended for public usage! Use the `Subscriber` or `UntypedSubscriber` instead! template class BaseSubscriber { diff --git a/iceoryx_posh/include/iceoryx_posh/internal/popo/client_impl.hpp b/iceoryx_posh/include/iceoryx_posh/internal/popo/client_impl.hpp index 702f288898..90ce648915 100644 --- a/iceoryx_posh/include/iceoryx_posh/internal/popo/client_impl.hpp +++ b/iceoryx_posh/include/iceoryx_posh/internal/popo/client_impl.hpp @@ -33,6 +33,8 @@ namespace iox { namespace popo { +/// @brief The ClientImpl class implements the typed client API +/// @note Not intended for public usage! Use the `Client` instead! template > class ClientImpl : public BaseClientT, private RpcInterface, ClientSendError> { diff --git a/iceoryx_posh/include/iceoryx_posh/internal/popo/publisher_impl.hpp b/iceoryx_posh/include/iceoryx_posh/internal/popo/publisher_impl.hpp index fb9bcea52d..b5bfacde1b 100644 --- a/iceoryx_posh/include/iceoryx_posh/internal/popo/publisher_impl.hpp +++ b/iceoryx_posh/include/iceoryx_posh/internal/popo/publisher_impl.hpp @@ -28,6 +28,8 @@ namespace iox { namespace popo { +/// @brief The PublisherImpl class implements the typed publisher API +/// @note Not intended for public usage! Use the `Publisher` instead! template > class PublisherImpl : public BasePublisherType, private PublisherInterface { diff --git a/iceoryx_posh/include/iceoryx_posh/internal/popo/server_impl.hpp b/iceoryx_posh/include/iceoryx_posh/internal/popo/server_impl.hpp index 12f42c7a7b..95af4130e0 100644 --- a/iceoryx_posh/include/iceoryx_posh/internal/popo/server_impl.hpp +++ b/iceoryx_posh/include/iceoryx_posh/internal/popo/server_impl.hpp @@ -33,6 +33,8 @@ namespace iox { namespace popo { +/// @brief The ServerImpl class implements the typed server API +/// @note Not intended for public usage! Use the `Server` instead! template > class ServerImpl : public BaseServerT, private RpcInterface, ServerSendError> { diff --git a/iceoryx_posh/include/iceoryx_posh/internal/popo/subscriber_impl.hpp b/iceoryx_posh/include/iceoryx_posh/internal/popo/subscriber_impl.hpp index e61d0f4b5d..45ccc7a94c 100644 --- a/iceoryx_posh/include/iceoryx_posh/internal/popo/subscriber_impl.hpp +++ b/iceoryx_posh/include/iceoryx_posh/internal/popo/subscriber_impl.hpp @@ -26,6 +26,8 @@ namespace iox { namespace popo { +/// @brief The SubscriberImpl class implements the typed subscriber API +/// @note Not intended for public usage! Use the `Subscriber` instead! template > class SubscriberImpl : public BaseSubscriberType { diff --git a/iceoryx_posh/include/iceoryx_posh/internal/popo/untyped_client_impl.hpp b/iceoryx_posh/include/iceoryx_posh/internal/popo/untyped_client_impl.hpp index 17c76e29a8..04b53ba5d0 100644 --- a/iceoryx_posh/include/iceoryx_posh/internal/popo/untyped_client_impl.hpp +++ b/iceoryx_posh/include/iceoryx_posh/internal/popo/untyped_client_impl.hpp @@ -27,6 +27,8 @@ namespace iox { namespace popo { +/// @brief The UntypedClientImpl class implements the untyped client API +/// @note Not intended for public usage! Use the `UntypedClient` instead! template > class UntypedClientImpl : public BaseClientT { diff --git a/iceoryx_posh/include/iceoryx_posh/internal/popo/untyped_publisher_impl.hpp b/iceoryx_posh/include/iceoryx_posh/internal/popo/untyped_publisher_impl.hpp index 45891f36ac..105ac6934c 100644 --- a/iceoryx_posh/include/iceoryx_posh/internal/popo/untyped_publisher_impl.hpp +++ b/iceoryx_posh/include/iceoryx_posh/internal/popo/untyped_publisher_impl.hpp @@ -25,6 +25,8 @@ namespace iox { namespace popo { +/// @brief The UntypedPublisherImpl class implements the untyped publisher API +/// @note Not intended for public usage! Use the `UntypedPublisher` instead! template > class UntypedPublisherImpl : public BasePublisherType { diff --git a/iceoryx_posh/include/iceoryx_posh/internal/popo/untyped_server_impl.hpp b/iceoryx_posh/include/iceoryx_posh/internal/popo/untyped_server_impl.hpp index 12c1b7d182..51ce6cd932 100644 --- a/iceoryx_posh/include/iceoryx_posh/internal/popo/untyped_server_impl.hpp +++ b/iceoryx_posh/include/iceoryx_posh/internal/popo/untyped_server_impl.hpp @@ -25,6 +25,8 @@ namespace iox { namespace popo { +/// @brief The UntypedServerImpl class implements the untyped server API +/// @note Not intended for public usage! Use the `UntypedServer` instead! template > class UntypedServerImpl : public BaseServerT { diff --git a/iceoryx_posh/include/iceoryx_posh/internal/popo/untyped_subscriber_impl.hpp b/iceoryx_posh/include/iceoryx_posh/internal/popo/untyped_subscriber_impl.hpp index a3191cb053..8a79acf3b6 100644 --- a/iceoryx_posh/include/iceoryx_posh/internal/popo/untyped_subscriber_impl.hpp +++ b/iceoryx_posh/include/iceoryx_posh/internal/popo/untyped_subscriber_impl.hpp @@ -32,6 +32,8 @@ class Void { }; +/// @brief The UntypedSubscriberImpl class implements the untyped subscriber API +/// @note Not intended for public usage! Use the `UntypedSubscriber` instead! template > class UntypedSubscriberImpl : public BaseSubscriberType { From cc200197e7c9c74dd3d8a396d01edae31019a5dd Mon Sep 17 00:00:00 2001 From: Mathias Kraus Date: Fri, 1 Apr 2022 16:15:42 +0200 Subject: [PATCH 4/4] iox-#1293 Update release notes --- doc/website/release-notes/iceoryx-v2-0-1.md | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/website/release-notes/iceoryx-v2-0-1.md b/doc/website/release-notes/iceoryx-v2-0-1.md index 6fd89405cb..72faf02a28 100644 --- a/doc/website/release-notes/iceoryx-v2-0-1.md +++ b/doc/website/release-notes/iceoryx-v2-0-1.md @@ -8,3 +8,4 @@ - CMake warning: empty command-line option [\#1311](https://github.com/eclipse-iceoryx/iceoryx/issues/1311) thanks to @clalancette - iox-#743 Fixes to make docs exportable [\#1289](https://github.com/eclipse-iceoryx/iceoryx/pull/1289) +- Don't exclude implementations of public classes in Doxygen [\#1293](https://github.com/eclipse-iceoryx/iceoryx/issues/1293)