Skip to content
This repository was archived by the owner on Jun 4, 2024. It is now read-only.

Commit c3738a7

Browse files
committed
Update javadocs and README
1 parent 5570ad6 commit c3738a7

File tree

4 files changed

+7
-8
lines changed

4 files changed

+7
-8
lines changed

readme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ It looks for the `lambda-logger.properties` resource and read properties:
7979
If not specified, defaults to _info_.
8080
* **levelInBrackets** - Should the level string be output in brackets? Defaults to `false`.
8181
* **showDateTime** - Set to `true` if you want the current date and time to be included in output
82-
messages. Default is `false`.
82+
messages. Defaults to `false`.
8383
* **showLogName** - Set to `true` if you want the Logger instance name to be included in output
8484
messages. Defaults to `true`.
8585
* **showShortLogName** - Set to `true` if you want the last component of the name to be included in

src/main/java/org/slf4j/impl/StaticMDCBinder.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
import org.slf4j.spi.MDCAdapter;
2020

2121
/**
22-
* Responsible for binding the {@link MDCAdapter}. This is used by the SLF4J API.
22+
* Responsible for binding the {@link BasicMDCAdapter}. This is used by the SLF4J API.
2323
*
2424
* @author Witalij Berdinskich
2525
* @since 1.0.0
@@ -39,7 +39,7 @@ public static StaticMDCBinder getSingleton() {
3939
}
4040

4141
/**
42-
* Returns an instance of {@link BasicMDCAdapter}.
42+
* This method always returns an instance of {@link BasicMDCAdapter}.
4343
*
4444
* @return instance of an MDCAdapter
4545
*/

src/main/java/org/slf4j/impl/StaticMarkerBinder.java

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,11 @@
1616
package org.slf4j.impl;
1717

1818
import org.slf4j.IMarkerFactory;
19-
import org.slf4j.MarkerFactory;
2019
import org.slf4j.helpers.BasicMarkerFactory;
2120
import org.slf4j.spi.MarkerFactoryBinder;
2221

2322
/**
24-
* Responsible for binding the {@link MarkerFactory}. This is used by the SLF4J API.
23+
* Responsible for binding the {@link BasicMarkerFactory}. This is used by the SLF4J API.
2524
*
2625
* @author Witalij Berdinskich
2726
* @since 1.0.0
@@ -43,7 +42,7 @@ public static StaticMarkerBinder getSingleton() {
4342
}
4443

4544
/**
46-
* This method always returns a {@link BasicMarkerFactory}.
45+
* This method always returns an instance of {@link BasicMarkerFactory}.
4746
*
4847
* @return a marker factory instance
4948
*/

src/main/java/uk/bot_by/aws_lambda/slf4j/LambdaLoggerConfiguration.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
* <li><strong>levelInBrackets</strong> - Should the level string be output in brackets?
4141
* Defaults to {@code false}.</li>
4242
* <li><strong>showDateTime</strong> - Set to {@code true} if you want the current date and time
43-
* to be included in output messages. Default is {@code false}.</li>
43+
* to be included in output messages. Defaults to {@code false}.</li>
4444
* <li><strong>showLogName</strong> - Set to {@code true} if you want the Logger instance name
4545
* to be included in output messages. Defaults to {@code true}.</li>
4646
* <li><strong>showShortLogName</strong> - Set to {@code true} if you want the last component of the name
@@ -208,7 +208,7 @@ public Builder name(@NotNull String name) {
208208
/**
209209
* Set to {@code true} if you want the current date and time to be included in output messages.
210210
* <p>
211-
* Default is {@code false}.
211+
* Defaults to {@code false}.
212212
*
213213
* @param showDateTime show date and time
214214
* @return a builder

0 commit comments

Comments
 (0)