Merge pull request #1312 from ApexAI/iox-#1311-increase-version-to-2.0.1

dkroenke · web-flow · commit ebdfcc5dfd60 · 2022-04-01T17:04:06.000+02:00
Iox #1311 increase version to 2.0.1
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-2.0.0
+2.0.1
diff --git 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
@@ -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})
 
@@ -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()
diff --git a/doc/website/release-notes/iceoryx-v2-0-1.md b/doc/website/release-notes/iceoryx-v2-0-1.md
@@ -0,0 +1,11 @@
+# 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)
+- Don't exclude implementations of public classes in Doxygen [\#1293](https://github.com/eclipse-iceoryx/iceoryx/issues/1293)
diff --git 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
@@ -2,7 +2,7 @@
 <?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
 <package format="3">
     <name>iceoryx_binding_c</name>
-    <version>2.0.0</version>
+    <version>2.0.1</version>
     <description>Eclipse iceoryx inter-process-communication (IPC) middleware C-Language Binding</description>
     <maintainer email="iceoryx-oss-support@apex.ai">Eclipse Foundation, Inc.</maintainer>
     <license>Apache 2.0</license>
diff --git 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
@@ -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
@@ -2,7 +2,7 @@
 <?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
 <package format="3">
     <name>iceoryx_hoofs</name>
-    <version>2.0.0</version>
+    <version>2.0.1</version>
     <description>Eclipse iceoryx inter-process-communication (IPC) middleware basic building blocks</description>
     <maintainer email="iceoryx-oss-support@apex.ai">Eclipse Foundation, Inc.</maintainer>
     <license>Apache 2.0</license>
diff --git a/iceoryx_integrationtest/package.xml b/iceoryx_integrationtest/package.xml
@@ -2,7 +2,7 @@
 <?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
 <package format="3">
   <name>iceoryx_integrationtest</name>
-  <version>2.0.0</version>
+  <version>2.0.1</version>
   <description>iceoryx Software Integrationtest</description>
     <maintainer email="iceoryx-oss-support@apex.ai">Eclipse Foundation, Inc.</maintainer>
     <license>Apache 2.0</license>
diff --git 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/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 <typename PortT = ClientPortUser, typename TriggerHandleT = TriggerHandle>
 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
@@ -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 <typename port_t = iox::PublisherPortUserType>
 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
@@ -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 <typename PortT = ServerPortUser, typename TriggerHandleT = TriggerHandle>
 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
@@ -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 <typename port_t = iox::SubscriberPortUserType>
 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
@@ -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 <typename Req, typename Res, typename BaseClientT = BaseClient<>>
 class ClientImpl : public BaseClientT, private RpcInterface<Request<Req>, 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
@@ -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 <typename T, typename H = mepoo::NoUserHeader, typename BasePublisherType = BasePublisher<>>
 class PublisherImpl : public BasePublisherType, private PublisherInterface<T, H>
 {
diff --git 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 <typename Req, typename Res, typename BaseServerT = BaseServer<>>
 class ServerImpl : public BaseServerT, private RpcInterface<Response<Res>, 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
@@ -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 <typename T, typename H = iox::mepoo::NoUserHeader, typename BaseSubscriberType = BaseSubscriber<>>
 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
@@ -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 <typename BaseClientT = BaseClient<>>
 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
@@ -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 <typename BasePublisherType = BasePublisher<>>
 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
@@ -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 <typename BaseServerT = BaseServer<>>
 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
@@ -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 <typename BaseSubscriberType = BaseSubscriber<>>
 class UntypedSubscriberImpl : public BaseSubscriberType
 {
diff --git a/iceoryx_posh/package.xml b/iceoryx_posh/package.xml
@@ -2,7 +2,7 @@
 <?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
 <package format="3">
     <name>iceoryx_posh</name>
-    <version>2.0.0</version>
+    <version>2.0.1</version>
     <description>Eclipse iceoryx inter-process-communication (IPC) middleware Posix Shared Memory Library and middleware daemon (RouDi)</description>
     <maintainer email="iceoryx-oss-support@apex.ai">Eclipse Foundation, Inc.</maintainer>
     <license>Apache 2.0</license>
diff --git 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})
 

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@`
`14`	`14`	`#`
`15`	`15`	`# SPDX-License-Identifier: Apache-2.0`
`16`	`16`	`cmake_minimum_required(VERSION 3.16)`
`17`		`-set(IOX_VERSION_STRING "2.0.0")`
	`17`	`+set(IOX_VERSION_STRING "2.0.1")`
`18`	`18`
`19`	`19`	`project(iceoryx_package VERSION ${IOX_VERSION_STRING})`
`20`	`20`