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 {