Fix JavaDoc problems reported by JDK 8.

13 files changed, 53 insertions, 5 deletions

diff --git a/org.jacoco.report/src/org/jacoco/report/FileMultiReportOutput.java b/org.jacoco.report/src/org/jacoco/report/FileMultiReportOutput.java
index c33061e4..2675bd35 100644
--- a/org.jacoco.report/src/org/jacoco/report/FileMultiReportOutput.java
+++ b/org.jacoco.report/src/org/jacoco/report/FileMultiReportOutput.java
@@ -31,6 +31,7 @@ public class FileMultiReportOutput implements IMultiReportOutput {
 	 * Creates a new instance for document output in the given base directory.
 	 * 
 	 * @param basedir
+	 *            base directory
 	 */
 	public FileMultiReportOutput(final File basedir) {
 		this.basedir = basedir;
diff --git a/org.jacoco.report/src/org/jacoco/report/internal/AbstractGroupVisitor.java b/org.jacoco.report/src/org/jacoco/report/internal/AbstractGroupVisitor.java
index b16b57d3..09dc0766 100644
--- a/org.jacoco.report/src/org/jacoco/report/internal/AbstractGroupVisitor.java
+++ b/org.jacoco.report/src/org/jacoco/report/internal/AbstractGroupVisitor.java
@@ -51,8 +51,11 @@ public abstract class AbstractGroupVisitor implements IReportGroupVisitor {
 	 * Called to handle the given bundle in a specific way.
 	 * 
 	 * @param bundle
+	 *            analyzed bundle
 	 * @param locator
+	 *            source locator
 	 * @throws IOException
+	 *             if the report can't be written
 	 */
 	protected abstract void handleBundle(IBundleCoverage bundle,
 			ISourceFileLocator locator) throws IOException;
@@ -68,8 +71,10 @@ public abstract class AbstractGroupVisitor implements IReportGroupVisitor {
 	 * Called to handle a group with the given name in a specific way.
 	 * 
 	 * @param name
+	 *            name of the group
 	 * @return created child group
 	 * @throws IOException
+	 *             if the report can't be written
 	 */
 	protected abstract AbstractGroupVisitor handleGroup(final String name)
 			throws IOException;
@@ -78,6 +83,7 @@ public abstract class AbstractGroupVisitor implements IReportGroupVisitor {
 	 * Must be called at the end of every group.
 	 * 
 	 * @throws IOException
+	 *             if the report can't be written
 	 */
 	public final void visitEnd() throws IOException {
 		finalizeLastChild();
@@ -88,6 +94,7 @@ public abstract class AbstractGroupVisitor implements IReportGroupVisitor {
 	 * Called to handle the end of this group in a specific way.
 	 * 
 	 * @throws IOException
+	 *             if the report can't be written
 	 */
 	protected abstract void handleEnd() throws IOException;
 
diff --git a/org.jacoco.report/src/org/jacoco/report/internal/html/HTMLGroupVisitor.java b/org.jacoco.report/src/org/jacoco/report/internal/html/HTMLGroupVisitor.java
index d43f63bb..40261853 100644
--- a/org.jacoco.report/src/org/jacoco/report/internal/html/HTMLGroupVisitor.java
+++ b/org.jacoco.report/src/org/jacoco/report/internal/html/HTMLGroupVisitor.java
@@ -38,9 +38,13 @@ public class HTMLGroupVisitor extends AbstractGroupVisitor {
 	 * Create a new group handler.
 	 * 
 	 * @param parent
+	 *            optional hierarchical parent
 	 * @param folder
+	 *            base folder for this group
 	 * @param context
+	 *            settings context
 	 * @param name
+	 *            group name
 	 */
 	public HTMLGroupVisitor(final ReportPage parent,
 			final ReportOutputFolder folder, final IHTMLReportContext context,
diff --git a/org.jacoco.report/src/org/jacoco/report/internal/html/page/BundlePage.java b/org.jacoco.report/src/org/jacoco/report/internal/html/page/BundlePage.java
index d1eba0c1..39fedda1 100644
--- a/org.jacoco.report/src/org/jacoco/report/internal/html/page/BundlePage.java
+++ b/org.jacoco.report/src/org/jacoco/report/internal/html/page/BundlePage.java
@@ -34,10 +34,15 @@ public class BundlePage extends TablePage<ICoverageNode> {
 	 * Creates a new visitor in the given context.
 	 * 
 	 * @param bundle
+	 *            coverage date for the bundle
 	 * @param parent
+	 *            optional hierarchical parent
 	 * @param locator
+	 *            source locator
 	 * @param folder
+	 *            base folder for this bundle
 	 * @param context
+	 *            settings context
 	 */
 	public BundlePage(final IBundleCoverage bundle, final ReportPage parent,
 			final ISourceFileLocator locator, final ReportOutputFolder folder,
diff --git a/org.jacoco.report/src/org/jacoco/report/internal/html/page/ClassPage.java b/org.jacoco.report/src/org/jacoco/report/internal/html/page/ClassPage.java
index f80aa076..047856d6 100644
--- a/org.jacoco.report/src/org/jacoco/report/internal/html/page/ClassPage.java
+++ b/org.jacoco.report/src/org/jacoco/report/internal/html/page/ClassPage.java
@@ -31,11 +31,15 @@ public class ClassPage extends TablePage<IClassCoverage> {
 	 * Creates a new visitor in the given context.
 	 * 
 	 * @param classNode
+	 *            coverage data for this class
 	 * @param parent
+	 *            optional hierarchical parent
 	 * @param sourcePage
 	 *            corresponding source page or <code>null</code>
 	 * @param folder
+	 *            base folder to create this page in
 	 * @param context
+	 *            settings context
 	 */
 	public ClassPage(final IClassCoverage classNode, final ReportPage parent,
 			final ILinkable sourcePage, final ReportOutputFolder folder,
diff --git a/org.jacoco.report/src/org/jacoco/report/internal/html/page/GroupPage.java b/org.jacoco.report/src/org/jacoco/report/internal/html/page/GroupPage.java
index 5d17e19f..2aae4d9a 100644
--- a/org.jacoco.report/src/org/jacoco/report/internal/html/page/GroupPage.java
+++ b/org.jacoco.report/src/org/jacoco/report/internal/html/page/GroupPage.java
@@ -25,9 +25,13 @@ public class GroupPage extends TablePage<ICoverageNode> {
 	 * Creates a new visitor in the given context.
 	 * 
 	 * @param node
+	 *            corresponding coverage data
 	 * @param parent
+	 *            optional hierarchical parent
 	 * @param folder
+	 *            base folder to create this page in
 	 * @param context
+	 *            settings context
 	 */
 	public GroupPage(final ICoverageNode node, final ReportPage parent,
 			final ReportOutputFolder folder, final IHTMLReportContext context) {
diff --git a/org.jacoco.report/src/org/jacoco/report/internal/html/page/NodePage.java b/org.jacoco.report/src/org/jacoco/report/internal/html/page/NodePage.java
index b6785756..c04e7d10 100644
--- a/org.jacoco.report/src/org/jacoco/report/internal/html/page/NodePage.java
+++ b/org.jacoco.report/src/org/jacoco/report/internal/html/page/NodePage.java
@@ -37,7 +37,7 @@ public abstract class NodePage<NodeType extends ICoverageNode> extends
 	 * @param parent
 	 *            optional hierarchical parent
 	 * @param folder
-	 *            base folder to create this report in
+	 *            base folder to create this page in
 	 * @param context
 	 *            settings context
 	 */
diff --git a/org.jacoco.report/src/org/jacoco/report/internal/html/page/PackagePage.java b/org.jacoco.report/src/org/jacoco/report/internal/html/page/PackagePage.java
index c9ee80e2..e74244f5 100644
--- a/org.jacoco.report/src/org/jacoco/report/internal/html/page/PackagePage.java
+++ b/org.jacoco.report/src/org/jacoco/report/internal/html/page/PackagePage.java
@@ -36,10 +36,15 @@ public class PackagePage extends TablePage<IPackageCoverage> {
 	 * Creates a new visitor in the given context.
 	 * 
 	 * @param node
+	 *            coverage data for this package
 	 * @param parent
+	 *            optional hierarchical parent
 	 * @param locator
+	 *            source locator
 	 * @param folder
+	 *            base folder to create this page in
 	 * @param context
+	 *            settings context
 	 */
 	public PackagePage(final IPackageCoverage node, final ReportPage parent,
 			final ISourceFileLocator locator, final ReportOutputFolder folder,
diff --git a/org.jacoco.report/src/org/jacoco/report/internal/html/page/ReportPage.java b/org.jacoco.report/src/org/jacoco/report/internal/html/page/ReportPage.java
index e56b7d30..a993e1ce 100644
--- a/org.jacoco.report/src/org/jacoco/report/internal/html/page/ReportPage.java
+++ b/org.jacoco.report/src/org/jacoco/report/internal/html/page/ReportPage.java
@@ -68,6 +68,7 @@ public abstract class ReportPage implements ILinkable {
 	 * must be called at most once.
 	 * 
 	 * @throws IOException
+	 *             if the page can't be written
 	 */
 	public void render() throws IOException {
 		final HTMLDocument doc = new HTMLDocument(
diff --git a/org.jacoco.report/src/org/jacoco/report/internal/html/page/SessionsPage.java b/org.jacoco.report/src/org/jacoco/report/internal/html/page/SessionsPage.java
index 7cf0b86c..f67447fe 100644
--- a/org.jacoco.report/src/org/jacoco/report/internal/html/page/SessionsPage.java
+++ b/org.jacoco.report/src/org/jacoco/report/internal/html/page/SessionsPage.java
@@ -56,11 +56,17 @@ public class SessionsPage extends ReportPage {
 	 * Creates a new page page to display session information.
 	 * 
 	 * @param sessionInfos
+	 *            session info objects
 	 * @param executionData
+	 *            execution data objects
 	 * @param index
+	 *            index for cross-linking
 	 * @param parent
+	 *            optional hierarchical parent
 	 * @param folder
+	 *            base folder to create this page in
 	 * @param context
+	 *            settings context
 	 */
 	public SessionsPage(final List<SessionInfo> sessionInfos,
 			final Collection<ExecutionData> executionData,
@@ -70,7 +76,7 @@ public class SessionsPage extends ReportPage {
 		this.sessionInfos = sessionInfos;
 		this.executionData = new ArrayList<ExecutionData>(executionData);
 		this.index = index;
-		dateFormat = DateFormat.getDateTimeInstance(DateFormat.DEFAULT,
+		this.dateFormat = DateFormat.getDateTimeInstance(DateFormat.DEFAULT,
 				DateFormat.DEFAULT, context.getLocale());
 		final ILanguageNames names = context.getLanguageNames();
 		Collections.sort(this.executionData, new Comparator<ExecutionData>() {
diff --git a/org.jacoco.report/src/org/jacoco/report/internal/html/page/SourceFilePage.java b/org.jacoco.report/src/org/jacoco/report/internal/html/page/SourceFilePage.java
index eda1d087..45ef7847 100644
--- a/org.jacoco.report/src/org/jacoco/report/internal/html/page/SourceFilePage.java
+++ b/org.jacoco.report/src/org/jacoco/report/internal/html/page/SourceFilePage.java
@@ -16,7 +16,7 @@ import static java.lang.String.format;
 import java.io.IOException;
 import java.io.Reader;
 
-import org.jacoco.core.analysis.ISourceFileCoverage;
+import org.jacoco.core.analysis.ISourceNode;
 import org.jacoco.report.internal.ReportOutputFolder;
 import org.jacoco.report.internal.html.HTMLElement;
 import org.jacoco.report.internal.html.IHTMLReportContext;
@@ -26,7 +26,7 @@ import org.jacoco.report.internal.html.resources.Resources;
  * Page showing the content of a source file with numbered and highlighted
  * source lines.
  */
-public class SourceFilePage extends NodePage<ISourceFileCoverage> {
+public class SourceFilePage extends NodePage<ISourceNode> {
 
 	private final Reader sourceReader;
 
@@ -36,13 +36,19 @@ public class SourceFilePage extends NodePage<ISourceFileCoverage> {
 	 * Creates a new page with given information.
 	 * 
 	 * @param sourceFileNode
+	 *            coverage data for this source file
 	 * @param sourceReader
+	 *            reader for the source code
 	 * @param tabWidth
+	 *            number of character per tab
 	 * @param parent
+	 *            optional hierarchical parent
 	 * @param folder
+	 *            base folder for this page
 	 * @param context
+	 *            settings context
 	 */
-	public SourceFilePage(final ISourceFileCoverage sourceFileNode,
+	public SourceFilePage(final ISourceNode sourceFileNode,
 			final Reader sourceReader, final int tabWidth,
 			final ReportPage parent, final ReportOutputFolder folder,
 			final IHTMLReportContext context) {
diff --git a/org.jacoco.report/src/org/jacoco/report/internal/html/page/TablePage.java b/org.jacoco.report/src/org/jacoco/report/internal/html/page/TablePage.java
index 9a7b8986..c24435a6 100644
--- a/org.jacoco.report/src/org/jacoco/report/internal/html/page/TablePage.java
+++ b/org.jacoco.report/src/org/jacoco/report/internal/html/page/TablePage.java
@@ -55,6 +55,7 @@ public abstract class TablePage<NodeType extends ICoverageNode> extends
 	 * is rendered.
 	 * 
 	 * @param item
+	 *            table item to add
 	 */
 	public void addItem(final ITableItem item) {
 		items.add(item);
diff --git a/org.jacoco.report/src/org/jacoco/report/internal/xml/XMLCoverageWriter.java b/org.jacoco.report/src/org/jacoco/report/internal/xml/XMLCoverageWriter.java
index 3bc4cd00..990e3e43 100644
--- a/org.jacoco.report/src/org/jacoco/report/internal/xml/XMLCoverageWriter.java
+++ b/org.jacoco.report/src/org/jacoco/report/internal/xml/XMLCoverageWriter.java
@@ -40,6 +40,8 @@ public final class XMLCoverageWriter {
 	 *            value of the name attribute
 	 * @return child element
 	 * @throws IOException
+	 *             if XML can't be written to the underlying output
+	 * 
 	 */
 	public static XMLElement createChild(final XMLElement parent,
 			final String tagname, final String name) throws IOException {
@@ -56,6 +58,7 @@ public final class XMLCoverageWriter {
 	 * @param element
 	 *            container element for the bundle data
 	 * @throws IOException
+	 *             if XML can't be written to the underlying output
 	 */
 	public static void writeBundle(final IBundleCoverage bundle,
 			final XMLElement element) throws IOException {
@@ -113,6 +116,7 @@ public final class XMLCoverageWriter {
 	 * @param parent
 	 *            container for the counter elements
 	 * @throws IOException
+	 *             if XML can't be written to the underlying output
 	 */
 	public static void writeCounters(final ICoverageNode node,
 			final XMLElement parent) throws IOException {