mirror of
https://github.com/github/codeql.git
synced 2025-12-23 04:06:37 +01:00
Update qhelp with content and remove autogenerated qhelp files
This commit is contained in:
Felicity Chapman
@@ -1,24 +0,0 @@
|
||||
<!DOCTYPE qhelp PUBLIC
|
||||
"-//Semmle//qhelp//EN"
|
||||
"qhelp.dtd">
|
||||
<qhelp>
|
||||
|
||||
|
||||
<overview>
|
||||
<p>This query shows graph of class inheritance hierarchy</p>
|
||||
|
||||
<p />
|
||||
|
||||
</overview>
|
||||
<section title="How to Address the Query Results">
|
||||
<p />
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</section>
|
||||
<references>
|
||||
|
||||
</references>
|
||||
</qhelp>
|
||||
@@ -1,6 +1,6 @@
|
||||
/**
|
||||
* @name Class hierarchies
|
||||
* @description Shows classes and their base classes.
|
||||
* @description Shows an inheritance hierarchy for classes and their base classes.
|
||||
* @kind graph
|
||||
* @id cpp/architecture/class-hierarchies
|
||||
* @graph.layout organic
|
||||
|
||||
@@ -1,25 +0,0 @@
|
||||
<!DOCTYPE qhelp PUBLIC
|
||||
"-//Semmle//qhelp//EN"
|
||||
"qhelp.dtd">
|
||||
<qhelp>
|
||||
|
||||
|
||||
<overview>
|
||||
<p>This query shows coupling between classes.</p>
|
||||
|
||||
<p>Red, large boxes are hub types that depend on many other classes
|
||||
and are depended on by many other classes.</p>
|
||||
|
||||
</overview>
|
||||
<section title="How to Address the Query Results">
|
||||
<p />
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</section>
|
||||
<references>
|
||||
|
||||
</references>
|
||||
</qhelp>
|
||||
@@ -1,6 +1,6 @@
|
||||
/**
|
||||
* @name Hub classes
|
||||
* @description Shows coupling between classes; red, large boxes are hub types that depend on many other classes
|
||||
* @description Shows coupling between classes. Large, red, boxes are hub types that depend on many other classes
|
||||
* and are depended on by many other classes.
|
||||
* @kind treemap
|
||||
* @id cpp/architecture/hub-classes
|
||||
|
||||
@@ -5,44 +5,34 @@
|
||||
|
||||
|
||||
<overview>
|
||||
<p>This query shows the distribution of inheritance depth across all types, i.e. classes. Library types are ignored.</p>
|
||||
<p>This query shows the distribution of inheritance depth across all types, that is, classes. Library types are ignored.</p>
|
||||
|
||||
<p>The result of this query is a line graph showing, for each number <i>n</i>, how many types have an inheritance depth of <i>n</i>, where
|
||||
the inheritance depth of a type is the length of a longest path in the inheritance hierarchy from top class to the type.</p>
|
||||
|
||||
<p>When hovering the mouse pointer over a specific depth value, the number of types having this inheritance depth is displayed.</p>
|
||||
|
||||
</overview>
|
||||
<section title="How to Address the Query Results">
|
||||
|
||||
<recommendation>
|
||||
<p>The depth of a type is an indication of how deeply nested a type is in a given design.
|
||||
Very deep types can be an indication of over-engineering, whereas a system with predominantly shallow types
|
||||
may not be exploiting object-orientation to the full.</p>
|
||||
</recommendation>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</section>
|
||||
<references>
|
||||
<li>
|
||||
Shyam R. Chidamber and Chris F. Kemerer.
|
||||
<a href="http://www.pitt.edu/~ckemerer/CK%20research%20papers/MetricForOOD_ChidamberKemerer94.pdf">A Metrics Suite for Object Oriented Design
|
||||
</a>.
|
||||
IEEE Transactions on Software Engineering,
|
||||
20(6), pages 476-493, June 1994.
|
||||
|
||||
|
||||
20(6), pages 476-493, June 1994.</li>
|
||||
|
||||
<li>
|
||||
<a href="http://www.dmst.aueb.gr/dds/index.en.html">Diomides D. Spinnelis</a>.
|
||||
<a href="http://www.spinellis.gr/codequality/">Code Quality: The Open Source Perspective</a>.
|
||||
Addison-Wesley 2007.
|
||||
|
||||
|
||||
Addison-Wesley 2007.</li>
|
||||
|
||||
<li>
|
||||
<a href="http://www.dmst.aueb.gr/dds/index.en.html">Diomides D. Spinnelis</a>.
|
||||
<a href="http://www.spinellis.gr/sw/ckjm/">ckjm - Chidamber and Kemerer Java Metrics</a>.
|
||||
(implementation of CK metrics), 2006.
|
||||
|
||||
|
||||
|
||||
</li></references></qhelp>
|
||||
(implementation of CK metrics), 2006.</li>
|
||||
</references>
|
||||
</qhelp>
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
/**
|
||||
* @name Inheritance depth distribution
|
||||
* @description Shows distribution of inheritance depth across all classes.
|
||||
* @description Shows the distribution of inheritance depth across all classes.
|
||||
* @kind chart
|
||||
* @id cpp/architecture/inheritance-depth-distribution
|
||||
* @chart.type line
|
||||
|
||||
@@ -7,19 +7,12 @@
|
||||
<overview>
|
||||
<p>This query shows namespaces that cyclically depend
|
||||
on one another.</p>
|
||||
|
||||
<p />
|
||||
|
||||
</overview>
|
||||
<section title="How to Address the Query Results">
|
||||
|
||||
<recommendation>
|
||||
<p>If there are cyclic dependencies between packages, they cannot be developed and tested independently. It is thus preferable to
|
||||
eliminate such cycles from the program.</p>
|
||||
eliminate such cycles from the program.</recommendation>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</section>
|
||||
<references>
|
||||
<li>Robert Martin's <a href="https://drive.google.com/file/d/0BwhCYaYDn8EgOGM2ZGFhNmYtNmE4ZS00OGY5LWFkZTYtMjE0ZGNjODQ0MjEx/view">Acyclic Dependencies Principle</a>.
|
||||
</li></references></qhelp>
|
||||
|
||||
@@ -5,18 +5,15 @@
|
||||
|
||||
|
||||
<overview>
|
||||
<p>This query finds classes that belong to no namespace</p>
|
||||
|
||||
<p>This query finds classes that belong to no namespace.</p>
|
||||
</overview>
|
||||
<section title="How to Address the Query Results">
|
||||
<p>If there are too many classes that belong to no namespace, consider creating namespaces to get a better project structure.</p>
|
||||
|
||||
<recommendation>
|
||||
<p>If there are many classes that belong to no namespace, consider defining namespaces to create a better project structure.</p>
|
||||
</recommendation>
|
||||
|
||||
|
||||
|
||||
|
||||
</section>
|
||||
<references>
|
||||
|
||||
<li>C++ reference: <a href="https://en.cppreference.com/w/cpp/language/namespace">Namespaces</a>
|
||||
</li>
|
||||
</references>
|
||||
</qhelp>
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
/**
|
||||
* @name Global namespace classes
|
||||
* @description Finds classes that belong to no namespace
|
||||
* @description Finds classes that belong to no namespace.
|
||||
* @kind table
|
||||
* @id cpp/architecture/global-namespace-classes
|
||||
*/
|
||||
|
||||
@@ -1,24 +0,0 @@
|
||||
<!DOCTYPE qhelp PUBLIC
|
||||
"-//Semmle//qhelp//EN"
|
||||
"qhelp.dtd">
|
||||
<qhelp>
|
||||
|
||||
|
||||
<overview>
|
||||
<p>This query finds namespace dependencies and draws hierarchical graph.</p>
|
||||
|
||||
<p />
|
||||
|
||||
</overview>
|
||||
<section title="How to Address the Query Results">
|
||||
<p />
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</section>
|
||||
<references>
|
||||
|
||||
</references>
|
||||
</qhelp>
|
||||
@@ -1,6 +1,6 @@
|
||||
/**
|
||||
* @name Namespace dependencies
|
||||
* @description Shows dependencies between namespaces.
|
||||
* @description Shows dependencies between namespaces as a hierarchical graph.
|
||||
* @kind graph
|
||||
* @id cpp/architecture/namespace-dependencies
|
||||
* @graph.layout hierarchical
|
||||
|
||||
Reference in New Issue
Block a user