Bommels05/maven-plugins
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve docs

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@291825 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
carlos 2005-09-27 05:10:52 +00:00
parent 182ece0bf6
commit a2db12c5aa
2 changed files with 93 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
jdepend/project.xml
View File

@ -22,8 +22,16 @@
<id>maven-jdepend-plugin</id>
<name>Maven JDepend Plugin</name>
<currentVersion>1.5.1-SNAPSHOT</currentVersion>
<description/>
<shortDescription>Produce metrics</shortDescription>
<shortDescription>
JDepend traverses Java class file directories and generates
design quality metrics for each Java package.
</shortDescription>
<description>
JDepend traverses Java class file directories and generates design quality metrics
for each Java package. JDepend allows you to automatically measure the quality of a
design in terms of its extensibility, reusability, and maintainability to manage
package dependencies effectively.
</description>
<url>http://maven.apache.org/reference/plugins/jdepend/</url>
<issueTrackingUrl>http://jira.codehaus.org/browse/MPJDEPEND</issueTrackingUrl>
<siteDirectory>/www/maven.apache.org/reference/plugins/jdepend/</siteDirectory>
@ -55,10 +63,10 @@
</roles>
</developer>
<developer>
<name>Stéphane Mor</name>
<name>Stéphane Mor</name>
<id>smor</id>
<email>stephanemor@yahoo.fr</email>
<organization>Hasgard Systèmes et Réseaux</organization>
<organization>Hasgard Systèmes et Réseaux</organization>
<roles>
<role>Java Developer</role>
</roles>

83
jdepend/xdocs/index.xml
View File

@ -27,9 +27,88 @@
<body>
<section name="Maven JDepend Plug-in">
<p>
This plug-in produces a nicely formatted metrics report based on
your project.
This plug-in produces a metrics report using
<a href="http://www.clarkware.com/software/JDepend.html">JDepend</a>.
</p>
<p>
JDepend traverses Java class file directories and generates design quality
metrics for each Java package. JDepend allows you to automatically measure
the quality of a design in terms of its extensibility, reusability, and
maintainability to manage package dependencies effectively.
</p>
<p>
Metrics for each Java package include:
<ul>
<li><b>Number of Classes and Interfaces</b>
<p>
The number of concrete and abstract classes (and interfaces) in the
package is an indicator of the extensibility of the package.
</p>
</li>
<li><b>Afferent Couplings (Ca)</b>
<p>
The number of other packages that depend upon classes within
the package is an indicator of the package's responsibility.
</p>
</li>
<li><b>Efferent Couplings (Ce)</b>
<p>
The number of other packages that the classes in the package depend
upon is an indicator of the package's independence.
</p>
</li>
<li><b>Abstractness (A)</b>
<p>
The ratio of the number of abstract classes (and interfaces)
in the analyzed package to the total number of classes in
the analyzed package.
</p>
<p>
The range for this metric is 0 to 1, with A=0 indicating a
completely concrete package and A=1 indicating a completely
abstract package.
</p>
</li>
<li><b>Instability (I)</b>
<p>
The ratio of efferent coupling (Ce) to total coupling
(Ce + Ca) such that I = Ce / (Ce + Ca). This metric is
an indicator of the package's resilience to change.
</p>
<p>
The range for this metric is 0 to 1, with I=0 indicating
a completely stable package and I=1 indicating a completely
instable package.
</p>
</li>
<li><b>Distance from the Main Sequence (D)</b>
<p>
The perpendicular distance of a package from the idealized
line A + I = 1. This metric is an indicator of the package's
balance between abstractness and stability.
</p>
<p>
A package squarely on the main sequence is optimally balanced
with respect to its abstractness and stability. Ideal packages
are either completely abstract and stable (x=0, y=1) or completely
concrete and instable (x=1, y=0).
</p>
<p>
The range for this metric is 0 to 1, with D=0 indicating
a package that is coincident with the main sequence and
D=1 indicating a package that is as far from the main sequence
as possible.
</p>
</li>
<li><b>Package Dependency Cycles</b>
<p>
Package dependency cycles are reported along with the hierarchical
paths of packages participating in package dependency cycles.
</p>
</li>
</ul>
</p>
</section>
</body>
</document>