FCL/sftools/dev/build: comparison buildframework/helium/sf/java/quality/src/com/nokia/helium/quality/ant/taskdefs/CodeScannerTask.java

equal deleted inserted replaced

-:c7c26511138f
+:7c4a911dc066
 *
 */
 package com.nokia.helium.quality.ant.taskdefs;
-import java.io.*;
+import java.io.File;
 import java.util.Vector;
+import org.apache.tools.ant.BuildException;
 import org.apache.tools.ant.Task;
-import org.apache.tools.ant.BuildException;
+import org.apache.tools.ant.taskdefs.ExecTask;
 import org.apache.tools.ant.types.Path;
-import org.apache.tools.ant.taskdefs.ExecTask;
 /**
-* This task executes codescanner - and writes the results to the output directory.
+* This task executes codescanner - and writes the results to the output directory. Codescanner
-* Codescanner parses C++ code and flags any inconsistencies or errors in output files.
+* parses C++ code and flags any inconsistencies or errors in output files. Configuration files are
-* Configuration files are used to determine what passes and fails the checking e.g. maximum length of lines,
+* used to determine what passes and fails the checking e.g. maximum length of lines, whether 'C'
-* whether 'C' type comments are allowed as well as C++ comments, does it adhere to the company coding
+* type comments are allowed as well as C++ comments, does it adhere to the company coding
-* guidelines and much more. Every person writing any C++ code
+* guidelines and much more. Every person writing any C++ code should run codescanner on their code
-* should run codescanner on their code to ensure it follows the coding guidelines. The output logs
+* to ensure it follows the coding guidelines. The output logs should have no errors and preferably
-* should have no errors and preferably no warnings before the code should be checked into SCM, e.g. synergy or SVN.
+* no warnings before the code should be checked into SCM, e.g. synergy or SVN.
 *
 * Below is an example of how to use the target to run codescanner.
 *
 * <pre>
 * &lt;property name="codescanner.output.dir" location="./cs" /&gt;
 * &lt;property name="codescanner.output.type" value="html" /&gt;
 * &lt;property name="codescanner.config" location="./codescanner_config.xml" /&gt;
 *
 * &lt;hlm:codescanner dest="${codescanner.output.dir}"
 *      format="${codescanner.output.type}"
 *      failonerror="true"
 *      configuration="${codescanner.config}"&gt;
 *      &lt;path refid="src.path"/&gt;
 private boolean auto;
 private File log;
 private boolean failonerror;
 /**
-* This defines if the task should fails in case of error while
+* This defines if the task should fails in case of error while executing codescanner.
-* executing codescanner.
 *
 * @param failonerror
 * @ant.not-required Default is false for backward compatibility.
 */
 public void setFailonerror(boolean failonerror) {
 * {@inheritDoc}
 */
 @Override
 public void execute() {
 // creating the exec subtask
-String osType = System.getProperty("os.name");
-if (!osType.toLowerCase().startsWith("win")) {
-this.log("CODESCANNER: run in windows only");
-return;
-}
 ExecTask task = new ExecTask();
 task.setProject(getProject());
 task.setTaskName(this.getTaskName());
 task.setFailonerror(failonerror);
 task.setExecutable("codescanner");
 if (dest == null) {
 throw new BuildException("'dest' attribute must be defined");
 }
 if (configuration != null) {
 if (!configuration.exists()) {
-throw new BuildException("Could not find the file "
+throw new BuildException("Could not find the file " + configuration);
-+ configuration);
+}
-} else {
+else {
 task.createArg().setValue("-c");
 task.createArg().setValue(configuration.getAbsolutePath());
 }
-} else {
+}
-throw new BuildException(
+else {
-"'configuration' attribute must be defined");
+throw new BuildException("'configuration' attribute must be defined");
 }
 if (!format.contains("xml")) {
 setFormat("xml," + format);
 }
 this.log("Output format: " + format);
 // -t off
 task.createArg().setValue("-t");
 task.createArg().setValue(auto ? "on" : "off");
 }
 for (int i = 0; i < srcs.size(); i++) {
 if (i != srcs.size() - 1) {
 task.createArg().setValue("-i");
 task.createArg().setValue(srcs.elementAt(i));
-} else {
+}
+else {
 task.createArg().setValue(srcs.elementAt(i));
 task.createArg().setValue(dest.toString());
 }
 }
 // output path

changeset 628	7c4a911dc066
parent 588	c7c26511138f
child 645	b8d81fa19e7d