Skip to content

Commit b174a21

Browse files
committed
doc: add missing JavaDoc
1 parent 63e4262 commit b174a21

File tree

2 files changed

+21
-0
lines changed

2 files changed

+21
-0
lines changed

logunit-log4j2/src/main/java/io/github/netmikey/logunit/log4j2/ListAppender.java

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,30 @@ public class ListAppender extends AbstractAppender {
2626
/**
2727
* Create a new instance.
2828
*
29+
* @param name
30+
* The new appender's name within the Log4j2 context.
31+
*
2932
* @return A new instance.
3033
*/
3134
public static ListAppender create(String name) {
3235
return new ListAppender(name, null, PatternLayout.createDefaultLayout(), true, Property.EMPTY_ARRAY);
3336
}
3437

38+
/**
39+
* Overridden constructor from log4j2 superclass.
40+
*
41+
* @param name
42+
* The Appender name.
43+
* @param filter
44+
* The Filter to associate with the Appender.
45+
* @param layout
46+
* The layout to use to format the event.
47+
* @param ignoreExceptions
48+
* If true, exceptions will be logged and suppressed. If false
49+
* errors will be logged and then passed to the application.
50+
* @param properties
51+
* The filter properties.
52+
*/
3553
protected ListAppender(String name, Filter filter, Layout<? extends Serializable> layout, boolean ignoreExceptions,
3654
Property[] properties) {
3755
super(name, filter, layout, ignoreExceptions, properties);

logunit-log4j2/src/main/java/io/github/netmikey/logunit/log4j2/Log4j2LogProvider.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@ public class Log4j2LogProvider extends BaseLogProvider {
2626

2727
private final ListAppender listAppender;
2828

29+
/**
30+
* Default constructor.
31+
*/
2932
public Log4j2LogProvider() {
3033
super();
3134
listAppender = ListAppender.create("LogUnitListAppender" + RAND.nextInt());

0 commit comments

Comments
 (0)