iox-#1293 Add note for internal header which are generated with the doxygen documentation

Author: elBoberido

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
 {

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

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
 {

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
 {

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>
 {

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>
 {

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>
 {

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
 {

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
 {

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
 {