[TECH] fix javadoc for release

Aurélien Baudet · Aurélien Baudet · commit c7ab577104dc · 2016-04-21T18:49:17.000+02:00
diff --git a/pom.xml b/pom.xml
@@ -156,6 +156,9 @@
 						<goals>
 							<goal>jar</goal>
 						</goals>
+						<configuration>
+							<excludePackageNames>fr.sii.sonar.test.junit.domain</excludePackageNames>
+						</configuration>
 					</execution>
 				</executions>
 			</plugin>
diff --git a/sonar-coverage-lcov/src/main/java/fr/sii/sonar/coverage/lcov/parser/domain/BranchCoverageDetail.java b/sonar-coverage-lcov/src/main/java/fr/sii/sonar/coverage/lcov/parser/domain/BranchCoverageDetail.java
@@ -6,7 +6,7 @@
  * LCOV unit branch information. It exactly corresponds to a BRDA line in the
  * LCOV file :
  * 
- * BRDA:<line number>,<block number>,<branch number>,<taken>
+ * {@literal BRDA:<line number>,<block number>,<branch number>,<taken>}
  * 
  * @author Aurélien Baudet
  * @see LcovBranchCoverageStatement
diff --git a/sonar-coverage-lcov/src/main/java/fr/sii/sonar/coverage/lcov/parser/domain/CoverageInfo.java b/sonar-coverage-lcov/src/main/java/fr/sii/sonar/coverage/lcov/parser/domain/CoverageInfo.java
@@ -16,12 +16,12 @@
  * of hit statements and the details for each statement. A statement can be a
  * line, a function or a branch. These information are provided by the following lines :
  * 
- * FNF:<number of functions found>
- * FNH:<number of function hit>
- * BRF:<number of branches found>
- * BRH:<number of branches hit>
- * LH:<number of lines with a non-zero execution count>
- * LF:<number of instrumented lines>
+ * {@literal FNF:<number of functions found>}
+ * {@literal FNH:<number of function hit>}
+ * {@literal BRF:<number of branches found>}
+ * {@literal BRH:<number of branches hit>}
+ * {@literal LH:<number of lines with a non-zero execution count>}
+ * {@literal LF:<number of instrumented lines>}
  * 
  * @author Aurélien Baudet
  *
diff --git a/sonar-coverage-lcov/src/main/java/fr/sii/sonar/coverage/lcov/parser/domain/FunctionCoverageDetail.java b/sonar-coverage-lcov/src/main/java/fr/sii/sonar/coverage/lcov/parser/domain/FunctionCoverageDetail.java
@@ -6,8 +6,8 @@
 /**
  * LCOV format provides information about covered functions. The function detailed information are provided by two different lines in the LCOV report :
  * 
- * FN:<line number of function start>,<function name>
- * FNDA:<execution count>,<function name>
+ * {@literal FN:<line number of function start>,<function name>}
+ * {@literal FNDA:<execution count>,<function name>}
  * 
  * This class groups the two pieces of information.
  * 
diff --git a/sonar-coverage-lcov/src/main/java/fr/sii/sonar/coverage/lcov/parser/domain/LineCoverageDetail.java b/sonar-coverage-lcov/src/main/java/fr/sii/sonar/coverage/lcov/parser/domain/LineCoverageDetail.java
@@ -6,7 +6,7 @@
  * Provides detail information about the number of line execution. This is
  * provided by the LCOV format with the line :
  * 
- * DA:<line number>,<execution count>[,<checksum>]
+ * {@literal DA:<line number>,<execution count>[,<checksum>]}
  * 
  * @author Aurélien Baudet
  * 
diff --git a/sonar-coverage-lcov/src/main/java/fr/sii/sonar/coverage/lcov/parser/statement/LcovBranchCoverageStatement.java b/sonar-coverage-lcov/src/main/java/fr/sii/sonar/coverage/lcov/parser/statement/LcovBranchCoverageStatement.java
@@ -12,7 +12,7 @@
 /**
  * Branch coverage information is stored which one line per branch:
  * 
- * BRDA:<line number>,<block number>,<branch number>,<taken>
+ * {@literal BRDA:<line number>,<block number>,<branch number>,<taken>}
  * 
  * Block number and branch number are gcc internal IDs for the branch. Taken is
  * either ’-’ if the basic block containing the branch was never executed or a
diff --git a/sonar-coverage-lcov/src/main/java/fr/sii/sonar/coverage/lcov/parser/statement/LcovFunctionExecutionCountStatement.java b/sonar-coverage-lcov/src/main/java/fr/sii/sonar/coverage/lcov/parser/statement/LcovFunctionExecutionCountStatement.java
@@ -12,7 +12,7 @@
 /**
  * Next, there is a list of execution counts for each instrumented function:
  * 
- * FNDA:<execution count>,<function name>
+ * {@literal FNDA:<execution count>,<function name>}
  * 
  * @author Aurélien Baudet
  *
diff --git a/sonar-coverage-lcov/src/main/java/fr/sii/sonar/coverage/lcov/parser/statement/LcovFunctionNameStatement.java b/sonar-coverage-lcov/src/main/java/fr/sii/sonar/coverage/lcov/parser/statement/LcovFunctionNameStatement.java
@@ -13,7 +13,7 @@
  * Following is a list of line numbers for each function name found in the
  * source file:
  * 
- * FN:<line number of function start>,<function name>
+ * {@literal FN:<line number of function start>,<function name>}
  * 
  * @author Aurélien Baudet
  *
diff --git a/sonar-coverage-lcov/src/main/java/fr/sii/sonar/coverage/lcov/parser/statement/LcovLineExecutionCountStatement.java b/sonar-coverage-lcov/src/main/java/fr/sii/sonar/coverage/lcov/parser/statement/LcovLineExecutionCountStatement.java
@@ -13,7 +13,7 @@
  * Then there is a list of execution counts for each instrumented line (i.e. a
  * line which resulted in executable code):
  * 
- * DA:<line number>,<execution count>[,<checksum>]
+ * {@literal DA:<line number>,<execution count>[,<checksum>]}
  * 
  * Note that there may be an optional checksum present for each instrumented
  * line. The current geninfo implementation uses an MD5 hash as checksumming
diff --git a/sonar-coverage-lcov/src/main/java/fr/sii/sonar/coverage/lcov/parser/statement/LcovNumberBranchFoundStatement.java b/sonar-coverage-lcov/src/main/java/fr/sii/sonar/coverage/lcov/parser/statement/LcovNumberBranchFoundStatement.java
@@ -10,7 +10,7 @@
 /**
  * Branch coverage summaries are stored in two lines:
  * 
- * BRF:<number of branches found>
+ * {@literal BRF:<number of branches found>}
  * 
  * @author Aurélien Baudet
  *
diff --git a/sonar-coverage-lcov/src/main/java/fr/sii/sonar/coverage/lcov/parser/statement/LcovNumberBranchHitStatement.java b/sonar-coverage-lcov/src/main/java/fr/sii/sonar/coverage/lcov/parser/statement/LcovNumberBranchHitStatement.java
@@ -10,7 +10,7 @@
 /**
  * Branch coverage summaries are stored in two lines:
  * 
- * BRH:<number of branches hit>
+ * {@literal BRH:<number of branches hit>}
  * 
  * @author Aurélien Baudet
  *
diff --git a/sonar-coverage-lcov/src/main/java/fr/sii/sonar/coverage/lcov/parser/statement/LcovNumberExecutedLineStatement.java b/sonar-coverage-lcov/src/main/java/fr/sii/sonar/coverage/lcov/parser/statement/LcovNumberExecutedLineStatement.java
@@ -11,7 +11,7 @@
  * At the end of a section, there is a summary about how many lines were found
  * and how many were actually instrumented:
  * 
- * LH:<number of lines with a non-zero execution count>
+ * {@literal LH:<number of lines with a non-zero execution count>}
  * 
  * @author Aurélien Baudet
  *
diff --git a/sonar-coverage-lcov/src/main/java/fr/sii/sonar/coverage/lcov/parser/statement/LcovNumberFunctionFoundStatement.java b/sonar-coverage-lcov/src/main/java/fr/sii/sonar/coverage/lcov/parser/statement/LcovNumberFunctionFoundStatement.java
@@ -11,7 +11,7 @@
  * This list is followed by two lines containing the number of functions found
  * and hit:
  * 
- * FNF:<number of functions found>
+ * {@literal FNF:<number of functions found>}
  * 
  * @author Aurélien Baudet
  *
diff --git a/sonar-coverage-lcov/src/main/java/fr/sii/sonar/coverage/lcov/parser/statement/LcovNumberFunctionHitStatement.java b/sonar-coverage-lcov/src/main/java/fr/sii/sonar/coverage/lcov/parser/statement/LcovNumberFunctionHitStatement.java
@@ -11,7 +11,7 @@
  * This list is followed by two lines containing the number of functions found
  * and hit:
  * 
- * FNH:<number of function hit>
+ * {@literal FNH:<number of function hit>}
  * 
  * @author Aurélien Baudet
  *
diff --git a/sonar-coverage-lcov/src/main/java/fr/sii/sonar/coverage/lcov/parser/statement/LcovNumberInstrumentedLineStatement.java b/sonar-coverage-lcov/src/main/java/fr/sii/sonar/coverage/lcov/parser/statement/LcovNumberInstrumentedLineStatement.java
@@ -11,7 +11,7 @@
  * At the end of a section, there is a summary about how many lines were found
  * and how many were actually instrumented:
  * 
- * LF:<number of instrumented lines>
+ * {@literal LF:<number of instrumented lines>}
  * 
  * @author Aurélien Baudet
  *
diff --git a/sonar-coverage-lcov/src/main/java/fr/sii/sonar/coverage/lcov/parser/statement/LcovSourceFileStatement.java b/sonar-coverage-lcov/src/main/java/fr/sii/sonar/coverage/lcov/parser/statement/LcovSourceFileStatement.java
@@ -4,7 +4,7 @@
 import fr.sii.sonar.coverage.lcov.parser.domain.LcovReport;
 
 /**
- * SF:<absolute path to the source file>
+ * {@literal SF:<absolute path to the source file>}
  * 
  * @author Aurélien Baudet
  *
diff --git a/sonar-coverage-lcov/src/main/java/fr/sii/sonar/coverage/lcov/parser/statement/LcovTestNameStatement.java b/sonar-coverage-lcov/src/main/java/fr/sii/sonar/coverage/lcov/parser/statement/LcovTestNameStatement.java
@@ -8,7 +8,7 @@
  * sections. If available, a tracefile begins with the testname which is stored
  * in the following format:
  * 
- * TN:<test name>
+ * {@literal TN:<test name>}
  * 
  * @author Aurélien Baudet
  *
diff --git a/sonar-report-core/src/main/java/fr/sii/sonar/report/core/common/ReportConstants.java b/sonar-report-core/src/main/java/fr/sii/sonar/report/core/common/ReportConstants.java
@@ -20,12 +20,16 @@ public interface ReportConstants extends BatchExtension, ServerExtension {
 	/**
 	 * The key for the configuration entry in sonar properties to indicate the
 	 * path to the report
+	 * 
+	 * @return the key for the report path property
 	 */
 	public String getReportPathKey();
 
 	/**
 	 * The key for the configuration entry in sonar properties to indicate what
 	 * to do if a sonar source file doesn't exist
+	 * 
+	 * @return the key for missing file property
 	 */
 	public String getMissingFileFailKey();
 }
diff --git a/sonar-report-core/src/main/java/fr/sii/sonar/report/core/common/ReportSensor.java b/sonar-report-core/src/main/java/fr/sii/sonar/report/core/common/ReportSensor.java
@@ -32,6 +32,8 @@
  * 
  * @author Aurélien Baudet
  *
+ * @param <R>
+ *            The type of handled report
  */
 public abstract class ReportSensor<R extends Report> implements Sensor {
 
@@ -43,6 +45,15 @@ public abstract class ReportSensor<R extends Report> implements Sensor {
 
 	/**
 	 * Use of IoC to get Settings
+	 * 
+	 * @param constants
+	 *            the constants for the current plugin
+	 * @param pluginDependencies
+	 *            the Sonar dependencies
+	 * @param providerFactory
+	 *            the factory for creating a new provider
+	 * @param saverFactory
+	 *            the factory for creating a new saver
 	 */
 	public ReportSensor(ReportConstants constants, PluginDependencies pluginDependencies, ProviderFactory<R> providerFactory, SaverFactory<R> saverFactory) {
 		super();
@@ -58,14 +69,14 @@ public boolean shouldExecuteOnProject(Project project) {
 		try {
 			File reportFile = getReportFile(project);
 			boolean exists = reportFile.exists();
-			if(exists) {
-				LOG.info("Loading and storing "+reportFile.getAbsolutePath()+" in Sonar");
-			} else if(!pluginContext.getSettings().getBoolean(ReportSensorConstants.SKIP_LOG_MISSING_REPORT_KEY)) {
-				LOG.warn("The report file "+reportFile.getAbsolutePath()+" doesn't exist");
+			if (exists) {
+				LOG.info("Loading and storing " + reportFile.getAbsolutePath() + " in Sonar");
+			} else if (!pluginContext.getSettings().getBoolean(ReportSensorConstants.SKIP_LOG_MISSING_REPORT_KEY)) {
+				LOG.warn("The report file " + reportFile.getAbsolutePath() + " doesn't exist");
 			}
 			return exists;
 		} catch (Exception e) {
-			LOG.error("Failed to find report file "+e.getMessage());
+			LOG.error("Failed to find report file " + e.getMessage());
 			return false;
 		}
 	}
diff --git a/sonar-report-core/src/main/java/fr/sii/sonar/report/core/common/language/LanguageConstants.java b/sonar-report-core/src/main/java/fr/sii/sonar/report/core/common/language/LanguageConstants.java
@@ -4,6 +4,8 @@ public interface LanguageConstants {
 	
 	/**
 	 * The language key
+	 * 
+	 * @return the language key
 	 */
 	public String getLanguageKey();
 
diff --git a/sonar-report-core/src/main/java/fr/sii/sonar/report/core/common/provider/XmlFileReportProvider.java b/sonar-report-core/src/main/java/fr/sii/sonar/report/core/common/provider/XmlFileReportProvider.java
@@ -46,7 +46,7 @@ public class XmlFileReportProvider<R extends Report, T> implements Provider<R> {
 
 	/**
 	 * Initialize the provider with the xml stream to parse and the class of the
-	 * report. In this case, <T> must extends Report
+	 * report. In this case, {@literal <T>} must extends Report
 	 * 
 	 * @param stream
 	 *            the xml stream to parse
@@ -62,15 +62,17 @@ public XmlFileReportProvider(InputStream stream, Class<T> xmlClass) {
 
 	/**
 	 * Initialize the provider with the xml file to parse and the class of the
-	 * report. In this case, <T> must extends Report
+	 * report. In this case, {@literal <T>} must extends Report
 	 * 
-	 * @param stream
+	 * @param reportFile
 	 *            the xml file to parse
 	 * @param xmlClass
 	 *            the class that will be instantiated and filled with the stream
 	 *            content
 	 * @throws IllegalArgumentException
 	 *             if xmlClass parameter doesn't implement {@link Report}
+	 * @throws FileNotFoundException
+	 *             when the report file doesn't exist
 	 */
 	public XmlFileReportProvider(File reportFile, Class<T> xmlClass) throws FileNotFoundException {
 		this(reportFile, checkClass(xmlClass), null);
@@ -110,19 +112,22 @@ public XmlFileReportProvider(InputStream stream, Class<T> xmlClass, ReportAdapte
 	 * @param adapter
 	 *            an adapter that transforms the raw structure into the final
 	 *            report structure
+	 * @throws FileNotFoundException
+	 *             when the report file doesn't exist
 	 */
 	public XmlFileReportProvider(File reportFile, Class<T> xmlClass, ReportAdapter<R, T> adapter) throws FileNotFoundException {
 		this(new FileInputStream(reportFile), xmlClass, adapter);
 	}
 
 	/**
-	 * Utility method used to check if the provided class is allowed or not.
-	 * The class is allowed if it implements {@link Report}.
+	 * Utility method used to check if the provided class is allowed or not. The
+	 * class is allowed if it implements {@link Report}.
 	 * 
 	 * @param xmlClass
 	 *            the class to check
 	 * @return xmlClass
-	 * @throws IllegalArgumentException if the class is not allowed.
+	 * @throws IllegalArgumentException
+	 *             if the class is not allowed.
 	 */
 	private static <T> Class<T> checkClass(Class<T> xmlClass) {
 		if (!Report.class.isAssignableFrom(xmlClass)) {
@@ -133,7 +138,7 @@ private static <T> Class<T> checkClass(Class<T> xmlClass) {
 
 	@SuppressWarnings("unchecked")
 	public R get() throws ProviderException {
-		try(Reader reader = new InputStreamReader(stream)) {
+		try (Reader reader = new InputStreamReader(stream)) {
 			Unmarshaller unmarshaller = JAXBContext.newInstance(xmlClass).createUnmarshaller();
 			Object rawStructure = unmarshaller.unmarshal(reader);
 			if (adapter != null) {
diff --git a/sonar-report-core/src/main/java/fr/sii/sonar/report/core/common/rules/RulesDefinitionConstants.java b/sonar-report-core/src/main/java/fr/sii/sonar/report/core/common/rules/RulesDefinitionConstants.java
@@ -16,21 +16,29 @@
 public interface RulesDefinitionConstants {
 	/**
 	 * The key of the repository
+	 * 
+	 * @return the key of the repository
 	 */
 	public String getRepositoryKey();
 
 	/**
 	 * The name of the repository
+	 * 
+	 * @return the name of the repository
 	 */
 	public String getRepositoryName();
 
 	/**
 	 * The path to the JSON file that contains the rules
+	 * 
+	 * @return the path to the JSON file that contains the rules
 	 */
 	public String getRulesJsonPath();
 
 	/**
 	 * The language managed by the repository
+	 * 
+	 * @return the language managed by the repository
 	 */
 	public String getLanguageKey();
 }
diff --git a/sonar-report-core/src/main/java/fr/sii/sonar/report/core/common/util/compat/StringEscapeUtils.java b/sonar-report-core/src/main/java/fr/sii/sonar/report/core/common/util/compat/StringEscapeUtils.java
diff --git a/sonar-report-core/src/main/java/fr/sii/sonar/report/core/common/util/compat/StringUtils.java b/sonar-report-core/src/main/java/fr/sii/sonar/report/core/common/util/compat/StringUtils.java
diff --git a/sonar-report-core/src/main/java/fr/sii/sonar/report/core/duplication/DuplicationConstants.java b/sonar-report-core/src/main/java/fr/sii/sonar/report/core/duplication/DuplicationConstants.java
diff --git a/sonar-report-core/src/main/java/fr/sii/sonar/report/core/duplication/save/DuplicationDetailsHelper.java b/sonar-report-core/src/main/java/fr/sii/sonar/report/core/duplication/save/DuplicationDetailsHelper.java
diff --git a/sonar-report-core/src/main/java/fr/sii/sonar/report/core/quality/QualityConstants.java b/sonar-report-core/src/main/java/fr/sii/sonar/report/core/quality/QualityConstants.java

Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`	`* LCOV unit branch information. It exactly corresponds to a BRDA line in the`
`7`	`7`	`* LCOV file :`
`8`	`8`	`*`
`9`		`- * BRDA:<line number>,<block number>,<branch number>,<taken>`
	`9`	`+ * {@literal BRDA:<line number>,<block number>,<branch number>,<taken>}`
`10`	`10`	`*`
`11`	`11`	`* @author Aurélien Baudet`
`12`	`12`	`* @see LcovBranchCoverageStatement`
Original file line number	Diff line number	Diff line change
`@@ -16,12 +16,12 @@`
`16`	`16`	`* of hit statements and the details for each statement. A statement can be a`
`17`	`17`	`* line, a function or a branch. These information are provided by the following lines :`
`18`	`18`	`*`
`19`		`- * FNF:<number of functions found>`
`20`		`- * FNH:<number of function hit>`
`21`		`- * BRF:<number of branches found>`
`22`		`- * BRH:<number of branches hit>`
`23`		`- * LH:<number of lines with a non-zero execution count>`
`24`		`- * LF:<number of instrumented lines>`
	`19`	`+ * {@literal FNF:<number of functions found>}`
	`20`	`+ * {@literal FNH:<number of function hit>}`
	`21`	`+ * {@literal BRF:<number of branches found>}`
	`22`	`+ * {@literal BRH:<number of branches hit>}`
	`23`	`+ * {@literal LH:<number of lines with a non-zero execution count>}`
	`24`	`+ * {@literal LF:<number of instrumented lines>}`
`25`	`25`	`*`
`26`	`26`	`* @author Aurélien Baudet`
`27`	`27`	`*`
Original file line number	Diff line number	Diff line change
`@@ -6,8 +6,8 @@`
`6`	`6`	`/**`
`7`	`7`	`* LCOV format provides information about covered functions. The function detailed information are provided by two different lines in the LCOV report :`
`8`	`8`	`*`
`9`		`- * FN:<line number of function start>,<function name>`
`10`		`- * FNDA:<execution count>,<function name>`
	`9`	`+ * {@literal FN:<line number of function start>,<function name>}`
	`10`	`+ * {@literal FNDA:<execution count>,<function name>}`
`11`	`11`	`*`
`12`	`12`	`* This class groups the two pieces of information.`
`13`	`13`	`*`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`	`* Provides detail information about the number of line execution. This is`
`7`	`7`	`* provided by the LCOV format with the line :`
`8`	`8`	`*`
`9`		`- * DA:<line number>,<execution count>[,<checksum>]`
	`9`	`+ * {@literal DA:<line number>,<execution count>[,<checksum>]}`
`10`	`10`	`*`
`11`	`11`	`* @author Aurélien Baudet`
`12`	`12`	`*`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@`
`12`	`12`	`/**`
`13`	`13`	`* Branch coverage information is stored which one line per branch:`
`14`	`14`	`*`
`15`		`- * BRDA:<line number>,<block number>,<branch number>,<taken>`
	`15`	`+ * {@literal BRDA:<line number>,<block number>,<branch number>,<taken>}`
`16`	`16`	`*`
`17`	`17`	`* Block number and branch number are gcc internal IDs for the branch. Taken is`
`18`	`18`	`* either ’-’ if the basic block containing the branch was never executed or a`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@`
`13`	`13`	`* Following is a list of line numbers for each function name found in the`
`14`	`14`	`* source file:`
`15`	`15`	`*`
`16`		`- * FN:<line number of function start>,<function name>`
	`16`	`+ * {@literal FN:<line number of function start>,<function name>}`
`17`	`17`	`*`
`18`	`18`	`* @author Aurélien Baudet`
`19`	`19`	`*`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@`
`10`	`10`	`/**`
`11`	`11`	`* Branch coverage summaries are stored in two lines:`
`12`	`12`	`*`
`13`		`- * BRF:<number of branches found>`
	`13`	`+ * {@literal BRF:<number of branches found>}`
`14`	`14`	`*`
`15`	`15`	`* @author Aurélien Baudet`
`16`	`16`	`*`