Doc: Update documentation for axivion pluginv17.0.0-beta2

Change-Id: I8848c4afe274db9c0b434cdb2680a224008ddb23
Reviewed-by: Leena Miettinen <[email protected]>

10 files changed, 94 insertions, 7 deletions

diff --git a/doc/qtcreator/images/icons/ax-dashboard.png b/doc/qtcreator/images/icons/ax-dashboard.png
new file mode 100644
index 00000000000..499e442ee37
--- /dev/null
+++ b/doc/qtcreator/images/icons/ax-dashboard.png
diff --git a/doc/qtcreator/images/icons/ax-localbuild.png b/doc/qtcreator/images/icons/ax-localbuild.png
new file mode 100644
index 00000000000..b4aab75601e
--- /dev/null
+++ b/doc/qtcreator/images/icons/ax-localbuild.png
diff --git a/doc/qtcreator/images/qtcreator-axivion-annotation.webp b/doc/qtcreator/images/qtcreator-axivion-annotation.webp
index 9cfd1407e30..222cd7e8982 100644
--- a/doc/qtcreator/images/qtcreator-axivion-annotation.webp
+++ b/doc/qtcreator/images/qtcreator-axivion-annotation.webp
diff --git a/doc/qtcreator/images/qtcreator-axivion-issue-search.webp b/doc/qtcreator/images/qtcreator-axivion-issue-search.webp
index d98c5929ad1..ee1ba5c9bcf 100644
--- a/doc/qtcreator/images/qtcreator-axivion-issue-search.webp
+++ b/doc/qtcreator/images/qtcreator-axivion-issue-search.webp
diff --git a/doc/qtcreator/images/qtcreator-axivion-localbuild-progress.webp b/doc/qtcreator/images/qtcreator-axivion-localbuild-progress.webp
new file mode 100644
index 00000000000..6d58e613b64
--- /dev/null
+++ b/doc/qtcreator/images/qtcreator-axivion-localbuild-progress.webp
diff --git a/doc/qtcreator/images/qtcreator-axivion-localbuild.webp b/doc/qtcreator/images/qtcreator-axivion-localbuild.webp
new file mode 100644
index 00000000000..3bac0f38726
--- /dev/null
+++ b/doc/qtcreator/images/qtcreator-axivion-localbuild.webp
diff --git a/doc/qtcreator/images/qtcreator-axivion-view-rule.webp b/doc/qtcreator/images/qtcreator-axivion-view-rule.webp
index 9bbca00d9ea..91a448ede17 100644
--- a/doc/qtcreator/images/qtcreator-axivion-view-rule.webp
+++ b/doc/qtcreator/images/qtcreator-axivion-view-rule.webp
diff --git a/doc/qtcreator/images/qtcreator-edit-dashboard-configuration.webp b/doc/qtcreator/images/qtcreator-edit-dashboard-configuration.webp
index 43d997ec424..92030db5be7 100644
--- a/doc/qtcreator/images/qtcreator-edit-dashboard-configuration.webp
+++ b/doc/qtcreator/images/qtcreator-edit-dashboard-configuration.webp
diff --git a/doc/qtcreator/images/qtcreator-preferences-axivion.webp b/doc/qtcreator/images/qtcreator-preferences-axivion.webp
index e2175144515..4cc5c17730e 100644
--- a/doc/qtcreator/images/qtcreator-preferences-axivion.webp
+++ b/doc/qtcreator/images/qtcreator-preferences-axivion.webp
diff --git a/doc/qtcreator/src/analyze/creator-axivion.qdoc b/doc/qtcreator/src/analyze/creator-axivion.qdoc
index 9e0adbd112e..3fc6c8b981b 100644
--- a/doc/qtcreator/src/analyze/creator-axivion.qdoc
+++ b/doc/qtcreator/src/analyze/creator-axivion.qdoc
@@ -17,9 +17,10 @@
 
     \section1 View inline annotations in editor
 
-    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 over an annotation to bring up a tooltip with a short
+    The editor shows found issues as inline annotations if the project is
+    configured with a path mapping or if the project matches the
+    currently open one and the respective file is part of the project.
+    Hover over an annotation to bring up a tooltip with a short
     description of the issue.
 
     \image {qtcreator-axivion-annotation.webp} {Annotation popup}
@@ -112,8 +113,10 @@
     Select \inlineimage icons/filtericon.png for a column to set or clear the
     filter expression for the column.
 
-    The information you see depends on the issue type. Double-click an issue
+    The information you see depends on the issue type. Select an issue
     to see more information about it in the \uicontrol {Issue Details} view.
+    Double-click an issue to see the code that causes the issue inside the
+    editor.
 
     To show inline issues, select \inlineimage icons/location.png.
 
@@ -134,8 +137,75 @@
     select the link in the details or in the \uicontrol {Right Path}
     or \uicontrol {Target Path} column.
 
-    \sa {Enable and disable plugins}, {Analyze}{How To: Analyze},
-    {Analyzers}, {Axivion}, {Analyzing Code}
+    \sa {Axivion}{Axivion Preferences}, {Local analysis with Axivion}{Local Analysis},
+    {Enable and disable plugins},{Analyze}{How To: Analyze}, {Analyzers},
+    {Analyzing Code}
+*/
+
+/*!
+    \page creator-axivion-localanalysis.html
+    \previouspage creator-how-tos.html
+
+    \ingroup creator-how-to-analyze
+
+    \title Local analysis with Axivion
+
+    You can perform local analysis for projects you are connected to on a dashboard.
+    In the issue table, select the respective dashboard and project.
+    You need to have the Axivion Suite set up locally and a valid licence.
+
+    To set up a local build for the active project inside the Axivion view:
+    \image {qtcreator-axivion-localbuild.webp} {Local Build dialog}
+    \list 1
+    \li Select \inlineimage {icons/ax-localbuild.png}{Local Build} in the issue
+    table.
+
+    \li Select the Axivion Suite base directory in
+    \uicontrol {Axivion Suite Installation Directory}.
+
+    \li Enter the command or choose a script or the respective JSON file holding
+    the Axivion configuration.
+
+    \li Select the build type from \uicontrol {Build Type}. You may choose either
+    a clean build or an incremental build.
+
+    \li Select \uicontrol {Start Local Build} to perform the build with the given
+    parameters.
+    \endlist
+
+    View running and finished local builds in \uicontrol {Local Build Progress}.
+
+    \image {qtcreator-axivion-localbuild-progress.webp} {Local Build Progress}
+
+    Right-click a local build to cancel a running build from the context menu.
+    You can inspect the Axivion or build log of local builds after they finished.
+    Select \uicontrol {Remove All Finished} to remove
+    the local builds which have finished already from the local build progress.
+
+    \section1 Local dashboard
+
+    If the current selected project has a local build present, you may see
+    its result by switching to the local dashboard view.
+
+    Select \inlineimage {icons/ax-dashboard.png}{Local Dashboard} to do so.
+    This starts the local dashboard and switches the issue table to display
+    the latest results.
+
+    Select \uicontrol {Local Dashboard} again to switch back to the global
+    dashboard.
+
+    Information about using the global dashboard applies to the local
+    dashboard as well (issue type selection, filtering), but you have only
+    a limited version selection.
+
+    In \uicontrol {Version}, you can switch between the reference version
+    of the global dashboard and the local dashboard results.
+    Depending on the local build result you may limit the issue table to
+    local issues or changed issues.
+
+    \sa {Axivion}{Axivion Preferences}, {View Axivion static code analysis results},
+    {Enable and disable plugins}, {Analyze}{How To: Analyze}, {Analyzers},
+    {Analyzing Code}
 */
 
 /*!
@@ -195,5 +265,22 @@
             computer.
     \endlist
 
-    \sa {Enable and disable plugins}, {View Axivion static code analysis results}
+    \section1 Local Analyses
+
+    To perform local analyses, specify additional settings.
+
+    In \uicontrol {Axivion Suite path}, enter the path to the locally installed
+    Axivion Suite.
+
+    In \uicontrol {BAUHAUS_PYTHON}, enter the path to the python executable to be
+    used by the local analysis if it cannot be found automatically.
+
+    In \uicontrol {JAVA_HOME}, enter the path to a Java runtime or Java development
+    kit if it cannot be found automatically.
+
+    Select \uicontrol {Save all open files before starting an analysis} to
+    automatically save files opened inside the editor before starting an analysis.
+
+    \sa {Enable and disable plugins}, {View Axivion static code analysis results},
+    {Local analysis with Axivion}{Local Analysis}
 */