Skip to content

Commit

Permalink
iox-#1142 Specify doxygen comments for service discovery
Browse files Browse the repository at this point in the history
Signed-off-by: Marika Lehmann <[email protected]>
  • Loading branch information
FerdinandSpitzschnueffler committed Feb 24, 2022
1 parent 7a38068 commit e54f2fb
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ void iox_service_discovery_deinit(iox_service_discovery_t const self);
/// @param[in] serviceContainerCapacity the capacity of the preallocated serviceContainer
/// @param[in] missedServices if the serviceContainer has insufficient size the number of missed services which could
/// not be written into the serviceContainer are stored here
/// @param[in] pattern messaging pattern of the service
/// @param[in] pattern messaging pattern of the service to search
/// @return the number of services which were written into the serviceContainer
uint64_t iox_service_discovery_find_service(iox_service_discovery_t const self,
const char* const service,
Expand All @@ -62,7 +62,7 @@ uint64_t iox_service_discovery_find_service(iox_service_discovery_t const self,
/// @param[in] instance instance string to search for, a nullptr corresponds to a wildcard
/// @param[in] event event string to search for, a nullptr corresponds to a wildcard
/// @param[in] callable to apply to all matching services
/// @param[in] pattern messaging pattern of the service
/// @param[in] pattern messaging pattern of the service to search
void iox_service_discovery_find_service_apply_callable(iox_service_discovery_t const self,
const char* const service,
const char* const instance,
Expand All @@ -78,7 +78,7 @@ void iox_service_discovery_find_service_apply_callable(iox_service_discovery_t c
/// @param[in] event event string to search for, a nullptr corresponds to a wildcard
/// @param[in] callable to apply to all matching services
/// @param[in] contextData a void pointer which is provided as second argument to the callback
/// @param[in] pattern messaging pattern of the service
/// @param[in] pattern messaging pattern of the service to search
void iox_service_discovery_find_service_apply_callable_with_context_data(
iox_service_discovery_t const self,
const char* const service,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ class ServiceDiscovery
/// @param[in] service service string to search for, a nullopt corresponds to a wildcard
/// @param[in] instance instance string to search for, a nullopt corresponds to a wildcard
/// @param[in] event event string to search for, a nullopt corresponds to a wildcard
/// @param[in] pattern messaging pattern to which the service belongs
/// @param[in] pattern messaging pattern of the service to search
/// @return ServiceContainer
/// ServiceContainer: container that is filled with all matching instances
ServiceContainer findService(const cxx::optional<capro::IdString_t>& service,
Expand All @@ -66,7 +66,7 @@ class ServiceDiscovery
/// @param[in] instance instance string to search for, a nullopt corresponds to a wildcard
/// @param[in] event event string to search for, a nullopt corresponds to a wildcard
/// @param[in] callableForEach callable to apply to all matching services
/// @param[in] pattern messaging pattern to which the service belongs
/// @param[in] pattern messaging pattern of the service to search
void findService(const cxx::optional<capro::IdString_t>& service,
const cxx::optional<capro::IdString_t>& instance,
const cxx::optional<capro::IdString_t>& event,
Expand Down

0 comments on commit e54f2fb

Please sign in to comment.