Generating Documentation

Subsystem Metrics

The following metrics are generated for each subsystem in a given architecture in a project. Multiple architectures can be defined for a project; a given display indicates the metrics for one specific architecture, and the subsystems it contains. As user changes are made to an architecture, by adding, moving or deleting a subsystem or its members, the metrics for that architecture are recalculated.

Size Metrics

Lines in Subsystem	Number of lines in the functions in the subsystem.
Lines of Source Code	Number of lines of code in the functions in the subsystem.
Related Source Files	Number of files containing function definitions, variable declarations and class declarations for the subsystem.
Classes in Subsystem	Number of classes in the subsystem.
Abstract Classes in Subsystem	Number of abstract classes in the system.
Members in Subsystem	Number of total members transitively in the subsystem. Includes subsystems as well as symbols.
Direct Members	Number of direct members of the subsystem. Includes subsystems as well as symbols.
Functions in Subsystem	Number of functions transitively in the subsystem.
Variables in Subsystem	Number of variables transitively in the subsystem.

Complexity Metrics

McCabe Total Complexity	Total cyclomatic complexity for all functions defined in the subsystem.
McCabe Average Complexity	Average cyclomatic complexity for all functions defined in the subsystem.
McCabe Maximum Complexity	Maximum cyclomatic complexity for any function defined in the subsystem.

Structure Metrics

Level in Hierarchy	Level of the subsystem in the architecture's overall hierarchy.
Depth of Interior Subsystems	Depth of the hierarchy of lower-level subsystems contained within the architecture.
Stability of Subsystem	Measure of how sensitive the subsystem is when classes in the subsystem are changed.
Average Usage of Subsystem	Measure of how many classes are affected when the subsystem is changed.
Instability of Subsystem	Measure of how concrete the subsystem is. The more that concrete implementations are used along with high dependency, the more instable a subsystem will become.
Abstractness of Subsystem	Ratio of abstract classes to total classes in subsystem.
Abstractness vs. Instability	Measure of abstractness versus instability.
Violations Relaxed	Number of external relationships in violation of relaxed layering.
Violations Strict	Number of external relationships in violation of strict layering.

Fan In Metrics

Class Usage Fan-In	Sum of number of classes outside the subsystem that depdend on classes inside the subsystem.
Function Call Fan-In	Number of functions outside the subsystem that call subsystem functions.
Subsystem Call Fan-In	Number of external subsystems that directly contain functions that call subsystem functions.
Variable Use Fan-In	Number of functions outside the subsystem that set or read subsystem variables.
Subsystem Use Fan-In	Number of external subsystems that directly contain functions that set or read subsystem variables.

Member Usage Metrics

Functions Called Total	Percentage of subsystem functions that are called from anywhere.
Functions Called External	Percentage of subsystem functions that are called from outside of the subsystem.
Variables Used Total	Percentage of subsystem variables that are set or read from anywhere.
Variables Used External	Percentage of subsystem variables that are set or read from outside of the subsystem.

Fan Out Metrics

Class Usage Fan-Out	Sum of number of classes outside the subsystem depended upon by classes inside the subsystem.
Function Call Fan-Out	Number of functions outside the subsystem that are called by subsystem functions.
Variable Use Fan-Out	Number of variables outside the subsystem that are set or read by subsystem functions.
Subsystem Use Fan-Out	Number of external subsystems that directly contain members that are used by subsystem functions.
Functions with External Dependencies	Percentage of subsystem functions that call, set or read symbols outside the subsystem.