Skip to content

Commit c1830e5

Browse files
committed
Fix Javadoc issue preventing the release and add licence headers
1 parent 89708ac commit c1830e5

File tree

3 files changed

+29
-6
lines changed

3 files changed

+29
-6
lines changed

core/src/main/java/org/quickperf/writer/DefaultWriterFactory.java

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
/*
2+
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
3+
*
4+
* http://www.apache.org/licenses/LICENSE-2.0
5+
*
6+
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
7+
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
8+
*
9+
* Copyright 2019-2020 the original author or authors.
10+
*/
11+
112
package org.quickperf.writer;
213

314
import java.io.PrintWriter;

core/src/main/java/org/quickperf/writer/WriterFactory.java

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
/*
2+
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
3+
*
4+
* http://www.apache.org/licenses/LICENSE-2.0
5+
*
6+
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
7+
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
8+
*
9+
* Copyright 2019-2020 the original author or authors.
10+
*/
11+
112
package org.quickperf.writer;
213

314
import java.io.IOException;
@@ -10,10 +21,11 @@
1021
public interface WriterFactory {
1122

1223
/**
24+
* <p>
1325
* This method is called by QuickPerf to build the <code>Writer</code>.
1426
* </p>
15-
* In case an exception is raised in the process, QuickPerf will use the default <code>Writer</code>
16-
* built on <code>System.out</code>.
27+
* <p>In case an exception is raised in the process, QuickPerf will use the default <code>Writer</code>
28+
* built on <code>System.out</code>.<p>
1729
*
1830
* @return an instance of the <code>Writer</code> used by QuickPerf to write messages
1931
* @throws IOException

jvm/jvm-annotations/src/main/java/org/quickperf/jvm/annotations/MeasureHeapAllocation.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,15 +37,15 @@
3737
String format() default QUICK_PERF_MEASURED_HEAP_ALLOCATION_DEFAULT_FORMAT;
3838

3939
/**
40-
* Allows you to provide a way to build a <code>Writer</code> instance to print your messages.
40+
* <p>Allows you to provide a way to build a <code>Writer</code> instance to print your messages.
4141
* The <code>WriterFactory</code> class is used to built this <code>Writer</code>.
4242
* </p>
43-
* This <code>WriterFactory</code> class is constructed using reflection, so it should have an empty
43+
* <p>This <code>WriterFactory</code> class is constructed using reflection, so it should have an empty
4444
* constructor. If it does not an exception will be raised and the default <code>Writer</code> will be used.
4545
* </p>
46-
* The default value <code>DefaultWriterFactory</code> builds a <code>Writer</code> that writes to
46+
* <p>The default value <code>DefaultWriterFactory</code> builds a <code>Writer</code> that writes to
4747
* <code>System.out</code>. In case an exception is raised in the use of a provided factory, the system
48-
* falls back on this default value.
48+
* falls back on this default value.</p>
4949
*
5050
* @return a class that implements the <code>WriterFactory</code> interface
5151
* @see WriterFactory

0 commit comments

Comments
 (0)