Skip to content

Commit 264fc59

Browse files
anoklanokl
committed
Use Doxygen style comments
1 parent baa0467 commit 264fc59

14 files changed

+379
-366
lines changed

‎Disruptor.PerfTests/OneToOneRawBatchThroughputTest.h‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ namespace PerfTests
5353
* RB - RingBuffer
5454
* SB - SequenceBarrier
5555
* EP1 - EventProcessor 1
56+
*
5657
*/
5758
class OneToOneRawBatchThroughputTest : public IThroughputTest
5859
{

‎Disruptor.PerfTests/OneToOneRawThroughputTest.h‎

Lines changed: 37 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -19,42 +19,43 @@ namespace Disruptor
1919
namespace PerfTests
2020
{
2121

22-
/// <summary>
23-
/// UniCast a series of items between 1 publisher and 1 event processor.
24-
/// +----+ +-----+
25-
/// | P1 |--->| EP1 |
26-
/// +----+ +-----+
27-
///
28-
/// Queue Based:
29-
/// ============
30-
///
31-
/// put take
32-
/// +----+ +====+ +-----+
33-
/// | P1 |---\| Q1 |/---| EP1 |
34-
/// +----+ +====+ +-----+
35-
///
36-
/// P1 - Publisher 1
37-
/// Q1 - Queue 1
38-
/// EP1 - EventProcessor 1
39-
///
40-
/// Disruptor:
41-
/// ==========
42-
/// track to prevent wrap
43-
/// +------------------+
44-
/// | |
45-
/// | v
46-
/// +----+ +====+ +====+ +-----+
47-
/// | P1 |--->| RB |/---| SB | | EP1 |
48-
/// +----+ +====+ +====+ +-----+
49-
/// claim get ^ |
50-
/// | |
51-
/// +--------+
52-
/// waitFor
53-
/// P1 - Publisher 1
54-
/// RB - RingBuffer
55-
/// SB - SequenceBarrier
56-
/// EP1 - EventProcessor 1
57-
/// </summary>
22+
/**
23+
* UniCast a series of items between 1 publisher and 1 event processor.
24+
* +----+ +-----+
25+
* | P1 |--->| EP1 |
26+
* +----+ +-----+
27+
*
28+
* Queue Based:
29+
* ============
30+
*
31+
* put take
32+
* +----+ +====+ +-----+
33+
* | P1 |---\| Q1 |/---| EP1 |
34+
* +----+ +====+ +-----+
35+
*
36+
* P1 - Publisher 1
37+
* Q1 - Queue 1
38+
* EP1 - EventProcessor 1
39+
*
40+
* Disruptor:
41+
* ==========
42+
* track to prevent wrap
43+
* +------------------+
44+
* | |
45+
* | v
46+
* +----+ +====+ +====+ +-----+
47+
* | P1 |--->| RB |/---| SB | | EP1 |
48+
* +----+ +====+ +====+ +-----+
49+
* claim get ^ |
50+
* | |
51+
* +--------+
52+
* waitFor
53+
* P1 - Publisher 1
54+
* RB - RingBuffer
55+
* SB - SequenceBarrier
56+
* EP1 - EventProcessor 1
57+
*
58+
*/
5859
class OneToOneRawThroughputTest : public IThroughputTest
5960
{
6061
//C# Run: Ops: 140 078 898 - Duration: 1 428 (ms)

‎Disruptor.PerfTests/OneToOneSequencedBatchThroughputTest.h‎

Lines changed: 27 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -16,34 +16,33 @@ namespace Disruptor
1616
namespace PerfTests
1717
{
1818

19-
/// <summary>
20-
/// UniCast a series of items between 1 publisher and 1 event processor
21-
///
22-
/// <code>
23-
/// +----+ +-----+
24-
/// | P1 |--->| EP1 |
25-
/// +----+ +-----+
26-
///
27-
/// Disruptor:
28-
/// ==========
29-
/// track to prevent wrap
30-
/// +------------------+
31-
/// | |
32-
/// | v
33-
/// +----+ +====+ +====+ +-----+
34-
/// | P1 |---›| RB |‹---| SB | | EP1 |
35-
/// +----+ +====+ +====+ +-----+
36-
/// claim get ^ |
37-
/// | |
38-
/// +--------+
39-
/// waitFor
40-
///
41-
/// P1 - Publisher 1
42-
/// RB - RingBuffer
43-
/// SB - SequenceBarrier
44-
/// EP1 - EventProcessor 1
45-
/// </code>
46-
/// </summary>
19+
/**
20+
* UniCast a series of items between 1 publisher and 1 event processor
21+
*
22+
* +----+ +-----+
23+
* | P1 |--->| EP1 |
24+
* +----+ +-----+
25+
*
26+
* Disruptor:
27+
* ==========
28+
* track to prevent wrap
29+
* +------------------+
30+
* | |
31+
* | v
32+
* +----+ +====+ +====+ +-----+
33+
* | P1 |---›| RB |‹---| SB | | EP1 |
34+
* +----+ +====+ +====+ +-----+
35+
* claim get ^ |
36+
* | |
37+
* +--------+
38+
* waitFor
39+
*
40+
* P1 - Publisher 1
41+
* RB - RingBuffer
42+
* SB - SequenceBarrier
43+
* EP1 - EventProcessor 1
44+
*
45+
**/
4746
class OneToOneSequencedBatchThroughputTest : public IThroughputTest
4847
{
4948
public:

‎Disruptor.PerfTests/OneToOneSequencedLongArrayThroughputTest.h‎

Lines changed: 25 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -14,32 +14,31 @@ namespace Disruptor
1414
namespace PerfTests
1515
{
1616

17-
/// <summary>
18-
/// UniCast a series of items between 1 publisher and 1 event processor.
19-
///
20-
/// <code>
21-
/// +----+ +-----+
22-
/// | P1 |--->| EP1 |
23-
/// +----+ +-----+
24-
/// Disruptor:
25-
/// ==========
26-
/// track to prevent wrap
27-
/// +------------------+
28-
/// | |
29-
/// | v
30-
/// +----+ +====+ +====+ +-----+
31-
/// | P1 |---›| RB |‹---| SB | | EP1 |
32-
/// +----+ +====+ +====+ +-----+
33-
/// claim get ^ |
34-
/// | |
35-
/// +--------+
36-
/// waitFor
37-
/// P1 - Publisher 1
38-
/// RB - RingBuffer
39-
/// SB - SequenceBarrier
40-
/// EP1 - EventProcessor 1
41-
/// </code>
42-
/// </summary>
17+
/**
18+
* UniCast a series of items between 1 publisher and 1 event processor.
19+
*
20+
* +----+ +-----+
21+
* | P1 |--->| EP1 |
22+
* +----+ +-----+
23+
* Disruptor:
24+
* ==========
25+
* track to prevent wrap
26+
* +------------------+
27+
* | |
28+
* | v
29+
* +----+ +====+ +====+ +-----+
30+
* | P1 |---›| RB |‹---| SB | | EP1 |
31+
* +----+ +====+ +====+ +-----+
32+
* claim get ^ |
33+
* | |
34+
* +--------+
35+
* waitFor
36+
* P1 - Publisher 1
37+
* RB - RingBuffer
38+
* SB - SequenceBarrier
39+
* EP1 - EventProcessor 1
40+
*
41+
*/
4342
class OneToOneSequencedLongArrayThroughputTest : public IThroughputTest
4443
{
4544
public:

‎Disruptor.PerfTests/OneToOneSequencedThroughputTest.h‎

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -18,33 +18,33 @@ namespace Disruptor
1818
namespace PerfTests
1919
{
2020

21-
/// <summary>
22-
///
23-
/// UniCast a series of items between 1 publisher and 1 event processor.
24-
///
25-
/// +----+ +-----+
26-
/// | P1 |--->| EP1 |
27-
/// +----+ +-----+
28-
///
29-
/// Disruptor:
30-
/// ==========
31-
/// track to prevent wrap
32-
/// +------------------+
33-
/// | |
34-
/// | v
35-
/// +----+ +====+ +====+ +-----+
36-
/// | P1 |---\| RB |/---| SB | | EP1 |
37-
/// +----+ +====+ +====+ +-----+
38-
/// claim get ^ |
39-
/// | |
40-
/// +--------+
41-
/// waitFor
42-
///
43-
/// P1 - Publisher 1
44-
/// RB - RingBuffer
45-
/// SB - SequenceBarrier
46-
/// EP1 - EventProcessor 1
47-
/// </summary>
21+
/**
22+
* UniCast a series of items between 1 publisher and 1 event processor.
23+
*
24+
* +----+ +-----+
25+
* | P1 |--->| EP1 |
26+
* +----+ +-----+
27+
*
28+
* Disruptor:
29+
* ==========
30+
* track to prevent wrap
31+
* +------------------+
32+
* | |
33+
* | v
34+
* +----+ +====+ +====+ +-----+
35+
* | P1 |---\| RB |/---| SB | | EP1 |
36+
* +----+ +====+ +====+ +-----+
37+
* claim get ^ |
38+
* | |
39+
* +--------+
40+
* waitFor
41+
*
42+
* P1 - Publisher 1
43+
* RB - RingBuffer
44+
* SB - SequenceBarrier
45+
* EP1 - EventProcessor 1
46+
*
47+
*/
4848
class OneToOneSequencedThroughputTest : public IThroughputTest
4949
{
5050
public:

‎Disruptor.PerfTests/OneToOneTranslatorThroughputTest.h‎

Lines changed: 28 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -16,29 +16,34 @@ namespace Disruptor
1616
namespace PerfTests
1717
{
1818

19-
/// <summary>
20-
/// UniCast a series of items between 1 publisher and 1 event processor using the EventTranslator API
21-
/// +----+ +-----+
22-
/// | P1 |--->| EP1 |
23-
/// +----+ +-----+
24-
/// Disruptor:
25-
/// ==========
26-
/// track to prevent wrap
27-
/// +------------------+
28-
/// | |
29-
/// | v
30-
/// +----+ +====+ +====+ +-----+
31-
/// | P1 |--->| RB |/---| SB | | EP1 |
32-
/// +----+ +====+ +====+ +-----+
33-
/// claim get ^ |
34-
/// | |
35-
/// +--------+
36-
/// waitFor
37-
/// P1 - Publisher 1
38-
/// RB - RingBuffer
39-
/// SB - SequenceBarrier
40-
/// EP1 - EventProcessor 1
41-
/// </summary>
19+
/**
20+
*
21+
* UniCast a series of items between 1 publisher and 1 event processor using the EventTranslator API
22+
*
23+
* +----+ +-----+
24+
* | P1 |--->| EP1 |
25+
* +----+ +-----+
26+
*
27+
* Disruptor:
28+
* ==========
29+
* track to prevent wrap
30+
* +------------------+
31+
* | |
32+
* | v
33+
* +----+ +====+ +====+ +-----+
34+
* | P1 |--->| RB |/---| SB | | EP1 |
35+
* +----+ +====+ +====+ +-----+
36+
* claim get ^ |
37+
* | |
38+
* +--------+
39+
* waitFor
40+
*
41+
* P1 - Publisher 1
42+
* RB - RingBuffer
43+
* SB - SequenceBarrier
44+
* EP1 - EventProcessor 1
45+
*
46+
*/
4247
class OneToOneTranslatorThroughputTest : public IThroughputTest
4348
{
4449
class Translator;

0 commit comments

Comments
 (0)