From 6b386945de2b88a975d42da908ac097395083206 Mon Sep 17 00:00:00 2001 From: Trent Houliston Date: Fri, 9 Aug 2024 13:42:40 +1000 Subject: [PATCH] Change in docs too --- docs/extension.rst | 10 +++++----- docs/networking.rst | 6 +++--- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/extension.rst b/docs/extension.rst index 7be48a91b..5e1dc45e8 100644 --- a/docs/extension.rst +++ b/docs/extension.rst @@ -43,7 +43,7 @@ Bind .. codeblock:: c++ template - static inline void bind(const std::shared_ptr& reaction, /*More arguments can be declared*/) + static void bind(const std::shared_ptr& reaction, /*More arguments can be declared*/) This function is called when the reaction is bound, it should be thought of as the constructor. It is used to setup anything that is required by the DSL word. @@ -68,7 +68,7 @@ Get .. codeblock:: c++ template - static inline T get(threading::ReactionTask& task) + static T get(threading::ReactionTask& task) This is used to get the data for the callback. The returned value is passed to the callback. @@ -84,7 +84,7 @@ Precondition .. codeblock:: c++ template - static inline bool precondition(threading::ReactionTask& task) + static bool precondition(threading::ReactionTask& task) A precondition is used to test if the reaction should run. On a true return the reaction will run as normal. On a false return the reaction will be dropped. @@ -103,7 +103,7 @@ Reschedule .. codeblock:: c++ template - static inline std::unique_ptr reschedule(std::unique_ptr&& task) + static std::unique_ptr reschedule(std::unique_ptr&& task) The ownership of the reaction task is passed to the DSL word. The task returned will be run instead of the passed in reaction task. If the returned task is the one passed in the task will be run normally. @@ -167,7 +167,7 @@ Now we define the `reschedule` to interrupt any new tasks if we are currently ru multithreaded so a mutex is needed when accessing the static members. .. codeblock:: c++ template - static inline std::unique_ptr reschedule( + static std::unique_ptr reschedule( std::unique_ptr&& task) { // Lock our mutex diff --git a/docs/networking.rst b/docs/networking.rst index f80a561ae..05d0c8edf 100644 --- a/docs/networking.rst +++ b/docs/networking.rst @@ -43,8 +43,8 @@ checks explicitly for an explicit type. Be careful about multiple declarations. For this partial specialisation three static methods need to be defined. .. codeblock:: c++ - static inline std::vector serialise(const T& in) + static std::vector serialise(const T& in) - static inline T deserialise(const std::vector& in) + static T deserialise(const std::vector& in) - static inline uint64_t hash() + static uint64_t hash()