Merge pull request #1931 from ApexAI/iox-1930-remove-backticks-and-ad…

…d-commit-hook-and-ci-check

iox-1930 remove backticks and add commit hook and ci check

.github/workflows/build-test.yml

@@ -21,6 +21,7 @@ jobs:
       - run: ./tools/scripts/clang_format.sh check
       - run: ./tools/scripts/list_stl_dependencies.sh check
       - run: ./tools/scripts/check_test_ids.sh
+      - run: ./tools/scripts/check_invalid_characters.sh
       - run: ./tools/ci/cmake-linter.sh
 
   build-test-ubuntu:

iceoryx_binding_c/include/iceoryx_binding_c/client.h

@@ -43,7 +43,7 @@ typedef struct
     /// @brief Sets whether the client blocks when the server request queue is full
     ENUM iox_ConsumerTooSlowPolicy serverTooSlowPolicy;
 
-    /// @brief this value will be set exclusively by `iox_client_options_init` and is not supposed to be modified
+    /// @brief this value will be set exclusively by 'iox_client_options_init' and is not supposed to be modified
     /// otherwise
     uint64_t initCheck;
 } iox_client_options_t;
@@ -85,8 +85,8 @@ void iox_client_deinit(iox_client_t const self);
 /// @param[in] payloadSize user-payload size of the allocated request
 /// @return on success it returns AllocationResult_SUCCESS otherwise a value which
 ///         describes the error
-/// @note for the user-payload alignment `IOX_C_CHUNK_DEFAULT_USER_PAYLOAD_ALIGNMENT` is used
-///       for a custom user-payload alignment please use `iox_client_loan_aligned_request`
+/// @note for the user-payload alignment 'IOX_C_CHUNK_DEFAULT_USER_PAYLOAD_ALIGNMENT' is used
+///       for a custom user-payload alignment please use 'iox_client_loan_aligned_request'
 ENUM iox_AllocationResult iox_client_loan_request(iox_client_t const self,
                                                   void** const payload,
                                                   const uint32_t payloadSize);

iceoryx_binding_c/include/iceoryx_binding_c/publisher.h

@@ -42,7 +42,7 @@ typedef struct
     /// @brief describes whether a publisher blocks when subscriber queue is full
     ENUM iox_ConsumerTooSlowPolicy subscriberTooSlowPolicy;
 
-    /// @brief this value will be set exclusively by `iox_pub_options_init` and is not supposed to be modified otherwise
+    /// @brief this value will be set exclusively by 'iox_pub_options_init' and is not supposed to be modified otherwise
     uint64_t initCheck;
 } iox_pub_options_t;
 
@@ -83,8 +83,8 @@ void iox_pub_deinit(iox_pub_t const self);
 /// @param[in] userPayloadSize user-payload size of the allocated chunk
 /// @return on success it returns AllocationResult_SUCCESS otherwise a value which
 ///         describes the error
-/// @note for the user-payload alignment `IOX_C_CHUNK_DEFAULT_USER_PAYLOAD_ALIGNMENT` is used
-///       for a custom user-payload alignment please use `iox_pub_loan_aligned_chunk`
+/// @note for the user-payload alignment 'IOX_C_CHUNK_DEFAULT_USER_PAYLOAD_ALIGNMENT' is used
+///       for a custom user-payload alignment please use 'iox_pub_loan_aligned_chunk'
 ENUM iox_AllocationResult iox_pub_loan_chunk(iox_pub_t const self,
                                              void** const userPayload,
                                              const uint32_t userPayloadSize);

iceoryx_binding_c/include/iceoryx_binding_c/server.h

@@ -43,7 +43,7 @@ typedef struct
     /// @brief Sets whether the server blocks when the client response queue is full
     ENUM iox_ConsumerTooSlowPolicy clientTooSlowPolicy;
 
-    /// @brief this value will be set exclusively by `iox_server_options_init` and is not supposed to be modified
+    /// @brief this value will be set exclusively by 'iox_server_options_init' and is not supposed to be modified
     /// otherwise
     uint64_t initCheck;
 } iox_server_options_t;
@@ -98,8 +98,8 @@ void iox_server_release_request(iox_server_t const self, const void* const paylo
 /// @param[in] payloadSize user-payload size of the allocated request
 /// @return on success it returns AllocationResult_SUCCESS otherwise a value which
 ///         describes the error
-/// @note for the user-payload alignment `IOX_C_CHUNK_DEFAULT_USER_PAYLOAD_ALIGNMENT` is used
-///       for a custom user-payload alignment please use `iox_server_loan_aligned_response`
+/// @note for the user-payload alignment 'IOX_C_CHUNK_DEFAULT_USER_PAYLOAD_ALIGNMENT' is used
+///       for a custom user-payload alignment please use 'iox_server_loan_aligned_response'
 ENUM iox_AllocationResult iox_server_loan_response(iox_server_t const self,
                                                    const void* const requestPayload,
                                                    void** const payload,

iceoryx_binding_c/include/iceoryx_binding_c/types.h

@@ -64,7 +64,7 @@ typedef struct
 /// @brief handle of the chunk header
 typedef struct
 {
-    // could be empty but then we get `struct has no members` warning
+    // could be empty but then we get 'struct has no members' warning
     uint8_t do_not_touch_me[1];
 } iox_chunk_header_t;
 

iceoryx_dust/include/iceoryx_dust/cli/command_line_argument_definition.hpp

@@ -35,8 +35,8 @@
 /// @param[in] type the type of the optional value
 /// @param[in] memberName the name under which the optional value is accessible
 /// @param[in] defaultValue the value when it is not set from outside
-/// @param[in] shortName a single character for the short option like `-s` for instance
-/// @param[in] longName a long option name under which this can be accessed like `--some-name` for instance
+/// @param[in] shortName a single character for the short option like '-s' for instance
+/// @param[in] longName a long option name under which this can be accessed like '--some-name' for instance
 /// @param[in] description a description of the optional value
 #define IOX_CLI_OPTIONAL(type, memberName, defaultValue, shortName, longName, description)                             \
     IOX_INTERNAL_CMD_LINE_VALUE(                                                                                       \
@@ -46,17 +46,17 @@
 ///        terminate
 /// @param[in] type the type of the required value
 /// @param[in] memberName the name under which the required value is accessible
-/// @param[in] shortName a single character for the short option like `-s` for instance
-/// @param[in] longName a long option name under which this can be accessed like `--some-name` for instance
+/// @param[in] shortName a single character for the short option like '-s' for instance
+/// @param[in] longName a long option name under which this can be accessed like '--some-name' for instance
 /// @param[in] description a description of the required value
 #define IOX_CLI_REQUIRED(type, memberName, shortName, longName, description)                                           \
     IOX_INTERNAL_CMD_LINE_VALUE(                                                                                       \
         type, memberName, type(), shortName, longName, description, iox::cli::OptionType::REQUIRED)
 
 /// @brief Adds a switch to the command line
 /// @param[in] memberName the name under which the switch is accessible
-/// @param[in] shortName a single character for the short option like `-s` for instance
-/// @param[in] longName a long option name under which this can be accessed like `--some-name` for instance
+/// @param[in] shortName a single character for the short option like '-s' for instance
+/// @param[in] longName a long option name under which this can be accessed like '--some-name' for instance
 /// @param[in] description a description of the switch
 #define IOX_CLI_SWITCH(memberName, shortName, longName, description)                                                   \
     IOX_INTERNAL_CMD_LINE_VALUE(bool, memberName, false, shortName, longName, description, iox::cli::OptionType::SWITCH)

iceoryx_dust/include/iceoryx_dust/internal/cli/arguments.hpp

@@ -33,7 +33,7 @@ namespace internal
 ///        CommandLineParser::parse creates and returns a populated Arguments
 ///        object.
 ///        This class should never be used directly. Use the CommandLine builder
-///        from `iceoryx_hoofs/cxx/command_line_argument_definition.hpp` to create a struct which contains
+///        from 'iceoryx_hoofs/cxx/command_line_argument_definition.hpp' to create a struct which contains
 ///        the values.
 class Arguments
 {

iceoryx_examples/waitset/ice_waitset_grouping.cpp

@@ -121,7 +121,7 @@ int main()
                 std::cout << "dismiss data\n";
                 auto subscriber = notification->getOrigin<iox::popo::UntypedSubscriber>();
                 // We need to release the data to reset the trigger hasData
-                // otherwise the WaitSet would notify us in `waitset.wait()` again
+                // otherwise the WaitSet would notify us in 'waitset.wait()' again
                 // instantly.
                 subscriber->releaseQueuedData();
             }

iceoryx_examples/waitset/ice_waitset_individual.cpp

@@ -91,7 +91,7 @@ int main()
             if (notification->doesOriginateFrom(&subscriber2))
             {
                 // We need to release the samples to reset the trigger hasSamples
-                // otherwise the WaitSet would notify us in `waitset.wait()` again
+                // otherwise the WaitSet would notify us in 'waitset.wait()' again
                 // instantly.
                 subscriber2.releaseQueuedData();
                 std::cout << "subscriber 2 received something - dont care\n";

iceoryx_examples/waitset/ice_waitset_trigger.cpp

@@ -52,7 +52,7 @@ class MyTriggerClass
     // IMPORTANT: For now the WaitSet does not support that the origin is moved
     //            or copied. To support that we have to inform the waitset about
     //            our new origin, otherwise the WaitSet would end up in the wrong
-    //            memory location when it calls the `hasTriggerCallback` with the
+    //            memory location when it calls the 'hasTriggerCallback' with the
     //            old origin (already moved) pointer. The same applies to
     //            the resetCallback which is used when the WaitSet goes out of scope
     //            and is pointing also to the old origin.

iceoryx_examples/waitset_in_c/ice_c_waitset_grouping.c

@@ -134,7 +134,7 @@ int main(void)
                 printf("dismiss data\n");
                 iox_sub_t subscriber = iox_notification_info_get_subscriber_origin(notification);
                 // We need to release the samples to reset the event hasSamples
-                // otherwise the WaitSet would notify us in `iox_ws_wait()` again
+                // otherwise the WaitSet would notify us in 'iox_ws_wait()' again
                 // instantly.
                 iox_sub_release_queued_chunks(subscriber);
             }

iceoryx_examples/waitset_in_c/ice_c_waitset_individual.c

@@ -118,7 +118,7 @@ int main(void)
             else if (iox_notification_info_does_originate_from_subscriber(notification, subscriber[1]))
             {
                 // We need to release the samples to reset the event hasSamples
-                // otherwise the WaitSet would notify us in `iox_ws_wait()` again
+                // otherwise the WaitSet would notify us in 'iox_ws_wait()' again
                 // instantly.
                 iox_sub_release_queued_chunks(subscriber[1U]);
                 printf("subscriber 2 received something - dont care\n");

iceoryx_hoofs/legacy/include/iceoryx_hoofs/iceoryx_hoofs_types.hpp

@@ -25,7 +25,7 @@ namespace iox
 /// [[deprecated("Deprecated in 3.0, removed in 4.0, please include 'iox/iceoryx_hoofs_types.hpp' instead")]]
 namespace cxx
 {
-/// @deprecated use `iox::byte` instead of `iox::cxx::byte_t`
+/// @deprecated use 'iox::byte' instead of 'iox::cxx::byte_t'
 using byte_t = byte;
 
 } // namespace cxx

iceoryx_posh/include/iceoryx_posh/capro/service_description.hpp

@@ -180,16 +180,16 @@ class ServiceDescription
 /// @return                                 Bool if comparison match or not
 bool serviceMatch(const ServiceDescription& first, const ServiceDescription& second) noexcept;
 
-/// @brief Convenience stream operator to easily use the `ServiceDescription` with std::ostream
+/// @brief Convenience stream operator to easily use the 'ServiceDescription' with std::ostream
 /// @param[in] stream output stream to write the message to
 /// @param[in] service ServiceDescription that shall be converted
-/// @return the reference to `stream` which was provided as input parameter
+/// @return the reference to 'stream' which was provided as input parameter
 std::ostream& operator<<(std::ostream& stream, const ServiceDescription& service) noexcept;
 
-/// @brief Convenience stream operator to easily use the `ServiceDescription` with log::LogStream
+/// @brief Convenience stream operator to easily use the 'ServiceDescription' with log::LogStream
 /// @param[in] stream output LogStream to write the message to
 /// @param[in] service ServiceDescription that shall be converted
-/// @return the reference to `stream` which was provided as input parameter
+/// @return the reference to 'stream' which was provided as input parameter
 log::LogStream& operator<<(log::LogStream& stream, const ServiceDescription& service) noexcept;
 
 } // namespace capro

iceoryx_posh/include/iceoryx_posh/iceoryx_posh_types.hpp

@@ -172,16 +172,16 @@ enum class ConnectionState : uint32_t
 /// @return pointer to a string literal
 inline constexpr const char* asStringLiteral(ConnectionState value) noexcept;
 
-/// @brief Convenience stream operator to easily use the `asStringLiteral` function with std::ostream
+/// @brief Convenience stream operator to easily use the 'asStringLiteral' function with std::ostream
 /// @param[in] stream sink to write the message to
 /// @param[in] value to convert to a string literal
-/// @return the reference to `stream` which was provided as input parameter
+/// @return the reference to 'stream' which was provided as input parameter
 inline std::ostream& operator<<(std::ostream& stream, ConnectionState value) noexcept;
 
-/// @brief Convenience stream operator to easily use the `asStringLiteral` function with iox::log::LogStream
+/// @brief Convenience stream operator to easily use the 'asStringLiteral' function with iox::log::LogStream
 /// @param[in] stream sink to write the message to
 /// @param[in] value to convert to a string literal
-/// @return the reference to `stream` which was provided as input parameter
+/// @return the reference to 'stream' which was provided as input parameter
 inline log::LogStream& operator<<(log::LogStream& stream, ConnectionState value) noexcept;
 
 // Default properties of ChunkDistributorData

iceoryx_posh/include/iceoryx_posh/internal/capro/capro_message.hpp

@@ -54,16 +54,16 @@ enum class CaproMessageType : uint8_t
 /// @return pointer to a string literal
 inline constexpr const char* asStringLiteral(CaproMessageType value) noexcept;
 
-/// @brief Convenience stream operator to easily use the `asStringLiteral` function with std::ostream
+/// @brief Convenience stream operator to easily use the 'asStringLiteral' function with std::ostream
 /// @param[in] stream sink to write the message to
 /// @param[in] value to convert to a string literal
-/// @return the reference to `stream` which was provided as input parameter
+/// @return the reference to 'stream' which was provided as input parameter
 inline std::ostream& operator<<(std::ostream& stream, CaproMessageType value) noexcept;
 
-/// @brief Convenience stream operator to easily use the `asStringLiteral` function with iox::log::LogStream
+/// @brief Convenience stream operator to easily use the 'asStringLiteral' function with iox::log::LogStream
 /// @param[in] stream sink to write the message to
 /// @param[in] value to convert to a string literal
-/// @return the reference to `stream` which was provided as input parameter
+/// @return the reference to 'stream' which was provided as input parameter
 inline log::LogStream& operator<<(log::LogStream& stream, CaproMessageType value) noexcept;
 
 enum class CaproServiceType : uint8_t

iceoryx_posh/include/iceoryx_posh/internal/mepoo/memory_manager.hpp

@@ -103,16 +103,16 @@ class MemoryManager
 /// @return pointer to a string literal
 inline constexpr const char* asStringLiteral(const MemoryManager::Error value) noexcept;
 
-/// @brief Convenience stream operator to easily use the `asStringLiteral` function with std::ostream
+/// @brief Convenience stream operator to easily use the 'asStringLiteral' function with std::ostream
 /// @param[in] stream sink to write the message to
 /// @param[in] value to convert to a string literal
-/// @return the reference to `stream` which was provided as input parameter
+/// @return the reference to 'stream' which was provided as input parameter
 std::ostream& operator<<(std::ostream& stream, const MemoryManager::Error value) noexcept;
 
-/// @brief Convenience stream operator to easily use the `asStringLiteral` function with iox::log::LogStream
+/// @brief Convenience stream operator to easily use the 'asStringLiteral' function with iox::log::LogStream
 /// @param[in] stream sink to write the message to
 /// @param[in] value to convert to a string literal
-/// @return the reference to `stream` which was provided as input parameter
+/// @return the reference to 'stream' which was provided as input parameter
 log::LogStream& operator<<(log::LogStream& stream, const MemoryManager::Error value) noexcept;
 
 } // namespace mepoo

iceoryx_posh/include/iceoryx_posh/internal/popo/base_client.hpp

@@ -34,7 +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!
+/// @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

@@ -32,7 +32,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!
+/// @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,7 +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!
+/// @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,7 +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!
+/// @note Not intended for public usage! Use the 'Subscriber' or 'UntypedSubscriber' instead!
 template <typename port_t = iox::SubscriberPortUserType>
 class BaseSubscriber
 {
@@ -120,7 +120,7 @@ class BaseSubscriber
     BaseSubscriber(BaseSubscriber&& rhs) = delete;
     BaseSubscriber& operator=(BaseSubscriber&& rhs) = delete;
 
-    /// @brief small helper method to unwrap the `expected<optional<ChunkHeader*>>` from the `tryGetChunk` method of the
+    /// @brief small helper method to unwrap the 'expected<optional<ChunkHeader*>>' from the 'tryGetChunk' method of the
     /// port
     expected<const mepoo::ChunkHeader*, ChunkReceiveResult> takeChunk() noexcept;
 

iceoryx_posh/include/iceoryx_posh/internal/popo/building_blocks/chunk_receiver.hpp

@@ -38,16 +38,16 @@ enum class ChunkReceiveResult
 /// @return pointer to a string literal
 inline constexpr const char* asStringLiteral(const ChunkReceiveResult value) noexcept;
 
-/// @brief Convenience stream operator to easily use the `asStringLiteral` function with std::ostream
+/// @brief Convenience stream operator to easily use the 'asStringLiteral' function with std::ostream
 /// @param[in] stream sink to write the message to
 /// @param[in] value to convert to a string literal
-/// @return the reference to `stream` which was provided as input parameter
+/// @return the reference to 'stream' which was provided as input parameter
 inline std::ostream& operator<<(std::ostream& stream, ChunkReceiveResult value) noexcept;
 
-/// @brief Convenience stream operator to easily use the `asStringLiteral` function with iox::log::LogStream
+/// @brief Convenience stream operator to easily use the 'asStringLiteral' function with iox::log::LogStream
 /// @param[in] stream sink to write the message to
 /// @param[in] value to convert to a string literal
-/// @return the reference to `stream` which was provided as input parameter
+/// @return the reference to 'stream' which was provided as input parameter
 inline log::LogStream& operator<<(log::LogStream& stream, ChunkReceiveResult value) noexcept;
 
 /// @brief The ChunkReceiver is a building block of the shared memory communication infrastructure. It extends