apache / maven-doxia-sitetools
Source Code Overview

Analysis scope, overview of main, test, generated, deployment, build, and other code.

Source Code Analysis Scope
Files includes and excluded from analyses
properties
cgi
txt
Overview of Analyzed Files
Basic stats on analyzed files
Intro
For analysis purposes we separate files in scope into several categories: main, test, generated, deployment and build, and other.

  • The main category contains all manually created source code files that are being used in the production.
  • Files in the main category are used as input for other analyses: logical decomposition, concerns, duplication, file size, unit size, and conditional complexity.
  • Test source code files are used only for testing of the product. These files are normally not deployed to production.
  • Build and deployment source code files are used to configure or support build and deployment process.
  • Generated source code files are automatically generated files that have not been manually changed after generation.
  • While a source code folder may contain a number of files, we are primarily interested in the source code files that are being written and maintained by developers.
  • Files containing binaries, documentation, or third-party libraries, for instance, are excluded from analysis. The exception are third-party libraries that have been changed by developers.

main2585 LOC (29%) 27 files
test4382 LOC (50%) 59 files
generated0 LOC (0%) 0 files
build and deployment836 LOC (9%) 5 files
other920 LOC (10%) 41 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
cgi
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 27 files match defined criteria (2,585 LOC, 100.0% vs. main code):
    • 18 *.java files (2,406 LOC)
    • 7 *.xml files (135 LOC)
    • 2 *.cgi files (44 LOC)
  • " *.java" is biggest, containing 93.08% of LOC.
  • " *.cgi" is smallest, containing 1.7% of LOC.


*.java2406 LOC (93%) 18 files
*.xml135 LOC (5%) 7 files
*.cgi44 LOC (1%) 2 files
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*/[Tt]est/.*".
  • 59 files match defined criteria (4,382 LOC, 169.5% vs. main code):
    • 18 *.java files (3,163 LOC)
    • 41 *.xml files (1,219 LOC)
  • " *.java" is biggest, containing 72.18% of LOC.
  • " *.xml" is smallest, containing 27.82% of LOC.


*.java3163 LOC (72%) 18 files
*.xml1219 LOC (27%) 41 files
Build and Deployment Code
Source code used to configure or support build and deployment process.
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*/pom[.]xml".
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
  • 5 files match defined criteria (836 LOC, 32.3% vs. main code). All matches are in *.xml files.


*.xml836 LOC (100%) 5 files
Other Code
properties
txt
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]txt".
    • files with paths like ".*[.]properties".
    • files with paths like ".*[.]json".
    • files with paths like ".*[.]md".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*/[.]gitignore".
  • 41 files match defined criteria (920 LOC, 35.6% vs. main code):
    • 39 *.properties files (797 LOC)
    • 1 *.md files (85 LOC)
    • 1 *.txt files (38 LOC)
  • " *.properties" is biggest, containing 86.63% of LOC.
  • " *.txt" is smallest, containing 4.13% of LOC.


*.properties797 LOC (86%) 39 files
*.md85 LOC (9%) 1 file
*.txt38 LOC (4%) 1 file
Analyzers
Info about analyzers used for source code examinations.

2023-08-10 10:57