From 05930812a1f85f8e9b72e7131ec951008d047b6a Mon Sep 17 00:00:00 2001 From: Felicity Chapman Date: Mon, 12 Nov 2018 09:47:25 +0000 Subject: [PATCH] Update for feedback --- .../InheritanceDepthDistribution.qhelp | 18 +++++++----------- .../HighDistanceFromMainLineNamespaces.qhelp | 12 ++++++++++-- 2 files changed, 17 insertions(+), 13 deletions(-) diff --git a/cpp/ql/src/Architecture/General Class-Level Information/InheritanceDepthDistribution.qhelp b/cpp/ql/src/Architecture/General Class-Level Information/InheritanceDepthDistribution.qhelp index ce1fad2322c..84c7c6ba350 100644 --- a/cpp/ql/src/Architecture/General Class-Level Information/InheritanceDepthDistribution.qhelp +++ b/cpp/ql/src/Architecture/General Class-Level Information/InheritanceDepthDistribution.qhelp @@ -19,20 +19,16 @@ may not be exploiting object-orientation to the full.

  • -Shyam R. Chidamber and Chris F. Kemerer. -A Metrics Suite for Object Oriented Design -. +Shyam R. Chidamber and Chris F. Kemerer, +A Metrics Suite for Object Oriented Design +. IEEE Transactions on Software Engineering, 20(6), pages 476-493, June 1994.
  • -Diomides D. Spinnelis. -Code Quality: The Open Source Perspective. -Addison-Wesley 2007.
    • - -
  • -Diomides D. Spinnelis. -ckjm - Chidamber and Kemerer Java Metrics. -(implementation of CK metrics), 2006.
    • +Lutz Prechelt, Barbara Unger, Michael Philippsen, and Walter Tich, A Controlled Experiment on Inheritance Depth as a Cost Factor for Code Maintenance +. +Journal of Systems and Software, 65 (2):115-126, 2003. +     diff --git a/cpp/ql/src/Metrics/Namespaces/HighDistanceFromMainLineNamespaces.qhelp b/cpp/ql/src/Metrics/Namespaces/HighDistanceFromMainLineNamespaces.qhelp index ad02846ce4f..5eb43361ebc 100644 --- a/cpp/ql/src/Metrics/Namespaces/HighDistanceFromMainLineNamespaces.qhelp +++ b/cpp/ql/src/Metrics/Namespaces/HighDistanceFromMainLineNamespaces.qhelp @@ -5,9 +5,17 @@ -

    This query finds namespaces that do not have a good balance between abstractness and stability.

    +

    This query finds namespaces that do not have a good balance between abstractness and stability where:

    + -

    This metric tries to capture the trade-off between abstractness +

    The metric tries to capture the trade-off between abstractness and instability. For an ideal balance, the sum of abstractness and instability should be one. That is, a package is completely abstract and stable (abstractness=1 and instability=0)