Skip to content
mrumpf edited this page Jun 18, 2012 · 4 revisions

FAQ

General

What does the 'Z' mean?

The Z as the plural S in the names came from the fact that the domain name jcoders.org had already been registered and so we decided to use the Z for all the plural form names in the future.

Where does the name fawkeZ come from?

The name fawkeZ has been chosen for this project when releasing it to the public internet. The previous name phoeniX has been found not unique enough to distinguish the project from many others with the same name. Fawkes is the name of a phoenix bird, appearing in the Harry Potter universe.

JcReport

What does the Quality percentage mean?

There is no special theory behind the quality percentage given in the report. The percentage should just give a rough estimate and a way to compare packages or to track changes within a package/project using a single number. As you might guess this is not very accurate but it does "it's job".

But how is the percentage calculated?

The quality is calculated in the calculateQuality method of the FileSummary class. The formula is:

quality_tmp = loc - INFO_WEIGHT * info - COVERAGE_FAILURE_WEIGHT * coverage - WARNING_WEIGHT * warning - ERROR_WEIGHT * error quality = max(0, ((quality_tmp * 100) / loc))

  • loc = lines of code
  • info = number of findings with severity info
  • warning = number of findings with severity warning
  • error = number of findings with severity error
  • coverage = number of not covered lines of code (0 if no coverage info is availavle)

The current configuration is:

  • INFO_WEIGHT = 0;
  • COVERAGE_FAILURE_WEIGHT = 1;
  • WARNING_WEIGHT = 4;
  • ERROR_WEIGHT = 12;