apache / maven-javadoc-plugin
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
txt
cgi
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.

main1542 LOC (10%) 215 files
test4545 LOC (29%) 186 files
generated0 LOC (0%) 0 files
build and deployment7114 LOC (46%) 204 files
other2058 LOC (13%) 125 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 ".*".
  • 215 files match defined criteria (1,542 LOC, 100.0% vs. main code):
    • 172 *.java files (1,104 LOC)
    • 35 *.groovy files (319 LOC)
    • 5 *.xml files (91 LOC)
    • 1 *.cgi files (22 LOC)
    • 1 *.jsp files (5 LOC)
    • 1 *.css files (1 LOC)
  • " *.java" is biggest, containing 71.6% of LOC.
  • " *.css" is smallest, containing 0.06% of LOC.


*.java1104 LOC (71%) 172 files
*.groovy319 LOC (20%) 35 files
*.xml91 LOC (5%) 5 files
*.cgi22 LOC (1%) 1 file
*.jsp5 LOC (<1%) 1 file
*.css1 LOC (<1%) 1 file
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/.*".
    • files with paths like ".*[-]test[-].*".
  • 186 files match defined criteria (4,545 LOC, 294.7% vs. main code):
    • 56 *.xml files (2,288 LOC)
    • 129 *.java files (2,256 LOC)
    • 1 *.html files (1 LOC)
  • " *.xml" is biggest, containing 50.34% of LOC.
  • " *.html" is smallest, containing 0.02% of LOC.


*.xml2288 LOC (50%) 56 files
*.java2256 LOC (49%) 129 files
*.html1 LOC (<1%) 1 file
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".
  • 204 files match defined criteria (7,114 LOC, 461.3% vs. main code). All matches are in *.xml files.


*.xml7114 LOC (100%) 204 files
Other Code
properties
txt
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]json".
    • files with paths like ".*[.]md".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]txt".
    • files with paths like ".*[.]properties".
    • files with paths like ".*/[Ee]xamples/.*".
  • 125 files match defined criteria (2,058 LOC, 133.5% vs. main code):
    • 100 *.properties files (1,801 LOC)
    • 1 *.md files (85 LOC)
    • 17 *.java files (69 LOC)
    • 2 *.xml files (58 LOC)
    • 3 *.txt files (33 LOC)
    • 2 *.groovy files (12 LOC)
  • " *.properties" is biggest, containing 87.51% of LOC.
  • " *.groovy" is smallest, containing 0.58% of LOC.


*.properties1801 LOC (87%) 100 files
*.md85 LOC (4%) 1 file
*.java69 LOC (3%) 17 files
*.xml58 LOC (2%) 2 files
*.txt33 LOC (1%) 3 files
*.groovy12 LOC (<1%) 2 files
Analyzers
Info about analyzers used for source code examinations.

2023-08-10 21:07