Skip to content

Commit 50a4d4e

Browse files
committed
style: format files
1 parent 7c09f5a commit 50a4d4e

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

include/hicr/frontends/channel/variableSize/spsc/consumer.hpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ class Consumer final : public variableSize::Base
5050
* \param[in] coordinationCommunicationManager The backend's memory manager to facilitate communication between the producer and consumer coordination buffers
5151
* \param[in] payloadCommunicationManager The backend's memory manager to facilitate communication between the producer and consumer payload buffers
5252
* \param[in] payloadBuffer The memory slot pertaining to the payload buffer. The producer will push messages into this
53-
* buffer, while there is enough space. This buffer should be large enough to hold twice the capacity specified by \ref payloadCapacity argument.
53+
* buffer, while there is enough space. This buffer should be large enough to hold twice the capacity specified by payloadCapacity argument.
5454
* Half of the buffer is used as excess buffer to avoid internal fragmentation of messages
5555
* \param[in] tokenBuffer The memory slot pertaining to the token buffer. This buffer is only used to exchange internal metadata
5656
* about the sizes of the individual messages being sent.
@@ -282,7 +282,7 @@ class Consumer final : public variableSize::Base
282282
* This funciton can be used to quickly check whether the channel is becoming full when trying
283283
* to push an element of a given size. First thing, we are checking if we can still
284284
* push tokens (i.e., if the coordination buffer has space). Second thing, we are checking the
285-
* payload buffer. If the current depth of the payload and the \ref requiredBufferSize to push
285+
* payload buffer. If the current depth of the payload and the requiredBufferSize to push
286286
* exceed the channel capacity, the channel is considered full.
287287
*
288288
* \param[in] requiredBufferSize size of the token to push into the channel

include/hicr/frontends/channel/variableSize/spsc/producer.hpp

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ class Producer : public variableSize::Base
4848
* \param[in] payloadCommunicationManager The backend's memory manager to facilitate communication between the producer and consumer payload buffers
4949
* \param[in] sizeInfoBuffer The local memory slot used to hold the information about the next message size
5050
* \param[in] payloadBuffer The global memory slot pertaining to the payload of all messages. The producer will push messages into this
51-
* buffer, while there is enough space. This buffer should be large enough to hold twice the capacity specified by \ref payloadCapacity argument.
51+
* buffer, while there is enough space. This buffer should be large enough to hold twice the capacity specified by payloadCapacity argument.
5252
* Half of the buffer is used as excess buffer to avoid internal fragmentation of messages
5353
* \param[in] tokenBuffer The memory slot pertaining to the token buffer, which is used to hold message size data.
5454
* The producer will push message sizes into this buffer, while there is enough space. This buffer should be large enough to
@@ -235,7 +235,7 @@ class Producer : public variableSize::Base
235235
* @return payload buffer capacity (in bytes)
236236
*/
237237
__INLINE__ size_t getPayloadCapacity() { return getCircularBufferForPayloads()->getCapacity(); }
238-
238+
239239
/**
240240
* Get depth of the coordination buffer of variable-size producer.
241241
* Because the current implementation first receives the payload (phase 1) before
@@ -264,7 +264,7 @@ class Producer : public variableSize::Base
264264
* This funciton can be used to quickly check whether the channel is becoming full when trying
265265
* to push an element of a given size. First thing, we are checking if we can still
266266
* push tokens (i.e., if the coordination buffer has space). Second thing, we are checking the
267-
* payload buffer. If the current depth of the payload and the \ref requiredBufferSize to push
267+
* payload buffer. If the current depth of the payload and the requiredBufferSize to push
268268
* exceed the channel capacity, the channel is considered full.
269269
*
270270
* \param[in] requiredBufferSize size of the token to push into the channel

0 commit comments

Comments
 (0)