feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Doc: Update Axivion plugin description

Browse Source 
I don't think we should have the descrptions in two places
(here and in the docs).

Task-number: QTCREATORBUG-31510
Change-Id: Id68fa3d9814a9255ed32e84c3aca87720dc98aae
Reviewed-by: Marcus Tillmanns <marcus.tillmanns@qt.io>
This commit is contained in:
Leena Miettinen
2024-11-01 11:40:06 +01:00
parent 91c6964f7b
commit 7a823ab397
1 changed files with 15 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
src/plugins/axivion/AxivionDescription.md
View File

@@ -4,26 +4,33 @@
Connect to an Axivion dashboard server from Qt Creator to view results of code analysis. Connect to an Axivion dashboard server from Qt Creator to view results of code analysis.
> **_NOTE:_** Enable the Axivion plugin to use it. > **_Note:_** To use the Axivion extension, you must be connected to an Axivion
dashboard server.
To use the plugin, you must set up a project in the Axivion dashboard server and link to it from Qt Creator. You can then see found issues in the Edit mode, issues in the Axivion dashboard, and issue details in the Axivion sidebar view. # View inline annotations in editor
The editor shows found issues as inline annotations. Hover the mouse over an annotation to bring up a tool tip with a short description of the issue. The editor shows found issues as inline annotations if the project matches the
currently open one and the respective file is part of the project. Hover the
mouse over an annotation to bring up a tooltip with a short description of the
issue.
![Annotation popup](https://doc.qt.io/qtcreator/images/qtcreator-axivion-annotation.webp) ![Annotation popup](https://doc.qt.io/qtcreator/images/qtcreator-axivion-annotation.webp)
Select ![](https://doc.qt.io/qtcreator/images/info.png) to view detailed information about the issue in the Axivion sidebar view. Select ![](https://doc.qt.io/qtcreator/images/info.png) to view detailed
information about the issue in the `Issue Details` view.
![Axivion sidebar view](https://doc.qt.io/qtcreator/images/qtcreator-axivion-view-rule.webp) ![Axivion sidebar view](https://doc.qt.io/qtcreator/images/qtcreator-axivion-view-rule.webp)
# View issue counts To hide inline annotations, go to `Analyze > Axivion` and clear
![](https://doc.qt.io/qtcreator/images/warning.png).
To view the issue counts, select (Show Dashboard) in the Axivion dashboard. # View issues
![Axivion dashboard](https://doc.qt.io/qtcreator/images/qtcreator-axivion-view.webp) To inspect issues found during the analyses, go to `Analyze > Axivion`.
The Axivion dashboard lists the numbers of the following types of issues that Axivion found in the linked project: ![Axivion dashboard](https://doc.qt.io/qtcreator/images/qtcreator-axivion-issue-search.webp)
Axivion looks for the following types of issues in the selected project:
| Icon | Type | Description | | Icon | Type | Description |
|-------|-------|--------------| |-------|-------|--------------|
@@ -33,29 +40,3 @@ The Axivion dashboard lists the numbers of the following types of issues that Ax
| ![DE](https://doc.qt.io/qtcreator/images/axivion-de.png) | DE | Dead entities are callable entities in the source code that cannot be reached from the entry points of the system under analysis. | | ![DE](https://doc.qt.io/qtcreator/images/axivion-de.png) | DE | Dead entities are callable entities in the source code that cannot be reached from the entry points of the system under analysis. |
| ![MV](https://doc.qt.io/qtcreator/images/axivion-mv.png) | MV | Violations of metrics based on lines and tokens, nesting, cyclomatic complexity, control flow, and so on. | | ![MV](https://doc.qt.io/qtcreator/images/axivion-mv.png) | MV | Violations of metrics based on lines and tokens, nesting, cyclomatic complexity, control flow, and so on. |
| ![SV](https://doc.qt.io/qtcreator/images/axivion-sv.png) | SV | Style violations, such as deviations from the naming or coding conventions. | | ![SV](https://doc.qt.io/qtcreator/images/axivion-sv.png) | SV | Style violations, such as deviations from the naming or coding conventions. |
To clear the view, select ![clear](https://doc.qt.io/qtcreator/images/clean_pane_small.png) (Clear).
To view issues, select ![seach](https://doc.qt.io/qtcreator/images/zoom.png) (Search for Issues).
# Filter issues
![Issues in Axivion view](https://doc.qt.io/qtcreator/images/qtcreator-axivion-issue-search.webp)
To filter issues, select:
- The icon of an issue type.
- Two analyzed versions to compare. Select EMPTY to see issues from the version you select in the right-side version box.
- to see only added issues.
- to see only removed issues.
- The owner of the issue. Select ANYBODY to see all issues, NOBODY to see issues that are not associated with a user, or a user name to see issues owned by a particular user.
- Path patterns to show issues in the files in the directories that match the pattern.
The information you see depends on the issue type. Double-click an issue to see more information about it in the Axivion sidebar view.
# Jump to issues in the editor
Typically, the details for cycles and clones show several paths. To view the issues in the editor:
Click in a location column (that shows a file or line) to open the respective location (if it can be found).
Click in other columns to open the first link in the issue details. Usually, it leads to the Left location or Source location.
The easiest way to jump to the Right location is to select the link in the details or in the Right Path or Target Path column.