apache / freemarker-docgen
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
txt
gitattributes
jshintrc
properties
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.

main9780 LOC (49%) 65 files
test1120 LOC (5%) 12 files
generated4087 LOC (20%) 1 file
build and deployment381 LOC (1%) 5 files
other4292 LOC (21%) 8 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 65 files match defined criteria (9,780 LOC, 100.0% vs. main code):
    • 32 *.java files (7,900 LOC)
    • 25 *.less files (1,317 LOC)
    • 5 *.js files (236 LOC)
    • 1 *.css files (187 LOC)
    • 2 *.ftl files (140 LOC)
  • " *.java" is biggest, containing 80.78% of LOC.
  • " *.ftl" is smallest, containing 1.43% of LOC.


*.java7900 LOC (80%) 32 files
*.less1317 LOC (13%) 25 files
*.js236 LOC (2%) 5 files
*.css187 LOC (1%) 1 file
*.ftl140 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 ".*[-]tests/.*".
    • files with paths like ".*/[Tt]est/.*".
  • 12 files match defined criteria (1,120 LOC, 11.5% vs. main code):
    • 6 *.xml files (818 LOC)
    • 4 *.java files (267 LOC)
    • 1 *.ftl files (19 LOC)
    • 1 *.bat files (16 LOC)
  • " *.xml" is biggest, containing 73.04% of LOC.
  • " *.bat" is smallest, containing 1.43% of LOC.


*.xml818 LOC (73%) 6 files
*.java267 LOC (23%) 4 files
*.ftl19 LOC (1%) 1 file
*.bat16 LOC (1%) 1 file
Generated Code
Automatically generated files, not manually changed after generation.
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*/package[-]lock[.]json".
  • 1 file matches defined criteria (4,087 LOC, 41.8% vs. main code). All matches are in *.json files.


*.json4087 LOC (100%) 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 ".*/build[.]xml".
    • files with paths like ".*/pom[.]xml".
    • files with paths like ".*[.]bat".
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/package[-]lock[.]json".
    • files with paths like ".*/package[.]json".
    • files with paths like ".*/[.]gitattributes".
  • 5 files match defined criteria (381 LOC, 3.9% vs. main code). All matches are in *.xml files.


*.xml381 LOC (100%) 5 files
Other Code
txt
properties
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]json".
    • files with paths like ".*[.]txt".
    • files with paths like ".*[.]md".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*[.]properties".
    • files with paths like ".*/[.]gitignore".
  • 8 files match defined criteria (4,292 LOC, 43.9% vs. main code):
    • 2 *.json files (4,111 LOC)
    • 4 *.txt files (102 LOC)
    • 1 *.md files (61 LOC)
    • 1 *.properties files (18 LOC)
  • " *.json" is biggest, containing 95.78% of LOC.
  • " *.properties" is smallest, containing 0.42% of LOC.


*.json4111 LOC (95%) 2 files
*.txt102 LOC (2%) 4 files
*.md61 LOC (1%) 1 file
*.properties18 LOC (<1%) 1 file
Analyzers
Info about analyzers used for source code examinations.

2023-08-10 15:57