Skip to content

Commit c490cc4

Browse files
committed
Javadoc fixes.
1 parent 2db0f41 commit c490cc4

6 files changed

Lines changed: 9 additions & 8 deletions

File tree

src/main/java/pl/mjaron/tinyloki/ILogCollector.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ public interface ILogCollector {
2222
void configureBufferingManager(IBuffering bufferingManager);
2323

2424
/**
25-
* If label settings are not <c>null</c>, the structured metadata is supported, else structured metadata should not be collected.
25+
* If label settings are not <code>null</code>, the structured metadata is supported, else structured metadata should not be collected.
2626
*
2727
* @param structuredMetadataLabelSettings Settings for structured metadata validation.
2828
* @since 1.1.0

src/main/java/pl/mjaron/tinyloki/ILogStream.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,8 @@ public interface ILogStream {
2323
/**
2424
* Thread-safe log line with custom time.
2525
*
26-
* @param line Log content.
26+
* @param timestampMs Log timestamp in milliseconds.
27+
* @param line Log content.
2728
* @since 1.1.0
2829
*/
2930
default void log(final long timestampMs, final String line) {

src/main/java/pl/mjaron/tinyloki/JsonLogCollector.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ public void configureStructuredMetadata(LabelSettings structuredMetadataLabelSet
3636
/**
3737
* Provides label settings for structured metadata.
3838
*
39-
* @return Label settings for structured metadata. It may be <c>null</c>.
39+
* @return Label settings for structured metadata. It may be <code>null</code>.
4040
* @since 1.1.0
4141
*/
4242
public LabelSettings getStructuredMetadataLabelSettings() {

src/main/java/pl/mjaron/tinyloki/LabelSettings.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
public class LabelSettings {
1414

1515
/**
16-
* Determines safe length of label name, based on default configuration of loki server at <c>limits_config</c>:
16+
* Determines safe length of label name, based on default configuration of loki server at <code>limits_config</code>:
1717
* <pre>{@code
1818
* [max_label_name_length: <int> | default = 1024]
1919
* }</pre>
@@ -24,7 +24,7 @@ public class LabelSettings {
2424
public static final int DEFAULT_MAX_LABEL_NAME_LENGTH = 1024;
2525

2626
/**
27-
* Determines safe length of label value, based on default configuration of loki server at <c>limits_config</c>:
27+
* Determines safe length of label value, based on default configuration of loki server at <code>limits_config</code>:
2828
* <pre>{@code
2929
* [max_label_value_length: <int> | default = 2048]
3030
* }</pre>

src/main/java/pl/mjaron/tinyloki/Settings.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -474,9 +474,9 @@ public LabelSettings getLabelSettings() {
474474
}
475475

476476
/**
477-
* Provides {@link LabelSettings} of structured metadata labels. If <c>null</c>, the structured metadata is not supported.
477+
* Provides {@link LabelSettings} of structured metadata labels. If <code>null</code>, the structured metadata is not supported.
478478
*
479-
* @return {@link LabelSettings} of structured metadata labels. If <c>null</c>, the structured metadata is not supported.
479+
* @return {@link LabelSettings} of structured metadata labels. If <code>null</code>, the structured metadata is not supported.
480480
* @since 1.1.0
481481
*/
482482
public LabelSettings getStructuredMetadataLabelSettings() {

src/main/java/pl/mjaron/tinyloki/TinyLoki.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ public static TinyLoki open(final String url, final String user, final String pa
161161
* Some settings will be overridden by this constructor.
162162
* @param logSender Sends the logs collected by log controller.
163163
* @param labelSettings Preferences of the {@link Labels}. See {@link LabelSettings}.
164-
* @param structuredMetadataLabelSettings Structured metadata label restrictions. If <c>null</c>, the structured metadata is not supported.
164+
* @param structuredMetadataLabelSettings Structured metadata label restrictions. If <code>null</code>, the structured metadata is not supported.
165165
* @param executor The {@link IExecutor} implementation.
166166
* @param bufferingManager The object responsible for buffering strategy.
167167
* @param logMonitor Handles diagnostic events from whole library.

0 commit comments

Comments
 (0)