Skip to content

Commit 129ea05

Browse files
committed
Improved class documentation
#14
1 parent 08d14d0 commit 129ea05

File tree

6 files changed

+11
-6
lines changed

6 files changed

+11
-6
lines changed

src/SplunkLogger/BatchManager.cs

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,13 @@
77
namespace Splunk
88
{
99
/// <summary>
10-
/// Class used at HEC loggers to control batch process.
10+
/// This class contains all methods and logics necessary to control a batch process.
1111
/// </summary>
12+
/// <remarks>
13+
/// Batch process is necessary to improve Splunk HEC performance. You need to dose
14+
/// your own batch size and/or interval speed but it's much better than send
15+
/// individual POST for each log entry.
16+
/// </remarks>
1217
public class BatchManager
1318
{
1419
readonly ConcurrentBag<object> events;

src/SplunkLogger/Providers/SplunkHECJsonLoggerProvider.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
namespace Splunk.Providers
1414
{
1515
/// <summary>
16-
/// Class used to provide Splunk HEC Json logger.
16+
/// This class is used to provide a Splunk HEC Json logger for each categoryName.
1717
/// </summary>
1818
public class SplunkHECJsonLoggerProvider : ILoggerProvider
1919
{

src/SplunkLogger/Providers/SplunkHECRawLoggerProvider.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
namespace Splunk.Providers
1212
{
1313
/// <summary>
14-
/// Class used to provide Splunk HEC Raw logger.
14+
/// This class is used to provide a Splunk HEC Raw logger for each categoryName.
1515
/// </summary>
1616
public class SplunkHECRawLoggerProvider : ILoggerProvider
1717
{

src/SplunkLogger/Providers/SplunkTcpLoggerProvider.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
namespace Splunk.Providers
88
{
99
/// <summary>
10-
/// Class used to provide Splunk Socket Tcp logger.
10+
/// This class is used to provide a Splunk Socket Tcp logger for each categoryName.
1111
/// </summary>
1212
public class SplunkTcpLoggerProvider : ILoggerProvider
1313
{

src/SplunkLogger/Providers/SplunkUdpLoggerProvider.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
namespace Splunk.Providers
88
{
99
/// <summary>
10-
/// Class used to provide Splunk Socket Udp logger.
10+
/// This class is used to provide a Splunk Socket Udp logger for each categoryName.
1111
/// </summary>
1212
public class SplunkUdpLoggerProvider : ILoggerProvider
1313
{

src/SplunkLogger/SplunkJSONEntry.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
namespace Splunk
33
{
44
/// <summary>
5-
/// Class used at HEC Json logger to store a log entry.
5+
/// This class represents a HEC Json log entry.
66
/// </summary>
77
public class SplunkJSONEntry
88
{

0 commit comments

Comments
 (0)