GUI: quick walk through in online-help
This commit is contained in:
Daniel Marjamäki
parent
a68d9e75ef
commit
ae0ad17152
Binary file not shown.
|
After Width: | Height: | Size: 139 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 12 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 4.6 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 10 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 6.5 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 10 KiB |
|
|
@ -8,45 +8,6 @@
|
||||||
|
|
||||||
<p>With the Cppcheck GUI you can analyze your code.</p>
|
<p>With the Cppcheck GUI you can analyze your code.</p>
|
||||||
|
|
||||||
<h2>Quick walk through</h2>
|
|
||||||
|
|
||||||
<h3>Step 1: Create a project.</h3>
|
|
||||||
|
|
||||||
<p>Create a new project.</p>
|
|
||||||
|
|
||||||
<p>In the <i>Paths and Defines</i> tab, it is recommended that you import your project file at the top.</p>
|
|
||||||
|
|
||||||
<p>In the <i>Types and Functions</i> tab, try to activate all 3rd party libraries you use (windows, posix, ...).</p>
|
|
||||||
|
|
||||||
<p>In the <i>Analysis</i> tab, leave the default settings to start with.</p>
|
|
||||||
|
|
||||||
<p>In the <i>Warnings options</i> tab, leave the default settings to start with.</p>
|
|
||||||
|
|
||||||
<p>In the <i>Addons</i> tab, leave the default settings to start with.</p>
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Step 2: Analyze code.</h3>
|
|
||||||
|
|
||||||
<p>When the project file has been created, the analysis will start automatically.</p>
|
|
||||||
|
|
||||||
<p>While analysis is performed in the background, you can investigate the warnings.</p>
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Step 3: Investigate warnings.</h3>
|
|
||||||
|
|
||||||
<p>In the toolbar you choose what types of warnings you want to see (error/warning/style/performance/portability/information).</p>
|
|
||||||
|
|
||||||
<p>All warnings are shown in a list. If you select a warning in the list, then details about that warning is shown below the list.</p>
|
|
||||||
|
|
||||||
<p>If you right click on warning(s) then you get a context menu.</p>
|
|
||||||
|
|
||||||
|
|
||||||
<h3>Step 4: Configuration.</h3>
|
|
||||||
|
|
||||||
<p>It is possible to improve configuration to get better analysis. The automatic assumptions are conservative and through configuration those automatic assumptions can be avoided.</p>
|
|
||||||
|
|
||||||
<p>TODO: library, contracts</p>
|
|
||||||
|
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -10,6 +10,7 @@
|
||||||
<section title="Project file dialog" ref="./projectfiledialog.html"/>
|
<section title="Project file dialog" ref="./projectfiledialog.html"/>
|
||||||
<section title="Standalone analysis" ref="./standalone-analysis.html"/>
|
<section title="Standalone analysis" ref="./standalone-analysis.html"/>
|
||||||
<section title="Tagging" ref="./tagging.html"/>
|
<section title="Tagging" ref="./tagging.html"/>
|
||||||
|
<section title="Quick walk through" ref="./walkthrough.html"/>
|
||||||
</section>
|
</section>
|
||||||
</toc>
|
</toc>
|
||||||
<keywords>
|
<keywords>
|
||||||
|
|
@ -23,6 +24,13 @@
|
||||||
<file>projectfiledialog.html</file>
|
<file>projectfiledialog.html</file>
|
||||||
<file>standalone-analysis.html</file>
|
<file>standalone-analysis.html</file>
|
||||||
<file>tagging.html</file>
|
<file>tagging.html</file>
|
||||||
|
<file>walkthrough.html</file>
|
||||||
|
<file>images/walkthrough-analysis.png</file>
|
||||||
|
<file>images/walkthrough-library.png</file>
|
||||||
|
<file>images/walkthrough-toolbar-severities.png</file>
|
||||||
|
<file>images/walkthrough-import-project.png</file>
|
||||||
|
<file>images/walkthrough-new-project.png</file>
|
||||||
|
<file>images/walkthrough-warning-menu.png</file>
|
||||||
</files>
|
</files>
|
||||||
</filterSection>
|
</filterSection>
|
||||||
</QtHelpProject>
|
</QtHelpProject>
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,69 @@
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<title>Walk through</title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
|
||||||
|
<h1>Quick walk through</h1>
|
||||||
|
|
||||||
|
This is a quick and short walk through to get you started.
|
||||||
|
|
||||||
|
<h2>Step 1: Create a project.</h2>
|
||||||
|
|
||||||
|
<p>Create a new project:</p>
|
||||||
|
|
||||||
|
<blockquote><img src="images/walkthrough-new-project.png"></blockquote>
|
||||||
|
|
||||||
|
<p>In the <i>Paths and Defines</i> tab, it is recommended that you import your
|
||||||
|
project file at the top.</p>
|
||||||
|
|
||||||
|
<blockquote><img src="images/walkthrough-import-project.png"></blockquote>
|
||||||
|
|
||||||
|
<p>In the <i>Types and Functions</i> tab, try to activate all 3rd party
|
||||||
|
libraries you use (windows, posix, ...).</p>
|
||||||
|
|
||||||
|
<blockquote><img src="images/walkthrough-library.png"></blockquote>
|
||||||
|
|
||||||
|
<p>In the <i>Analysis</i> tab, leave the default settings to start with.</p>
|
||||||
|
|
||||||
|
<p>In the <i>Warnings options</i> tab, leave the default settings to start
|
||||||
|
with.</p>
|
||||||
|
|
||||||
|
<p>In the <i>Addons</i> tab, leave the default settings to start with.</p>
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Step 2: Analyze code.</h2>
|
||||||
|
|
||||||
|
<p>When the project file has been created, the analysis will start
|
||||||
|
automatically.</p>
|
||||||
|
|
||||||
|
<p>While analysis is performed in the background, you can investigate the
|
||||||
|
results.</p>
|
||||||
|
|
||||||
|
<blockquote><img src="images/walkthrough-analysis.png"></blockquote>
|
||||||
|
|
||||||
|
|
||||||
|
<h2>Step 3: Investigate warnings.</h2>
|
||||||
|
|
||||||
|
<p>In the toolbar you choose what types of warnings you want to see
|
||||||
|
(error/warning/style/performance/portability/information).</p>
|
||||||
|
|
||||||
|
<blockquote><img src="images/walkthrough-toolbar-severities.png"></blockquote>
|
||||||
|
|
||||||
|
|
||||||
|
<p>All warnings are shown in a list. If you select a warning in the list, then
|
||||||
|
details about that warning is shown.</p>
|
||||||
|
|
||||||
|
<p>If you right click on warning(s) then you get a context menu.</p>
|
||||||
|
|
||||||
|
<blockquote><img src="images/walkthrough-warning-menu.png"></blockquote>
|
||||||
|
|
||||||
|
<p>The difference of "Hide" and "Suppress" is that
|
||||||
|
suppressions are saved in the project file. The suppressed warnings will not be
|
||||||
|
shown again unless you remove the suppression. When you hide a warning then
|
||||||
|
they will be temporarily hidden; the next time you analyze your code these
|
||||||
|
warnings will be shown again.</p>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
|
||||||
|
|
@ -53,16 +53,6 @@
|
||||||
<widget class="HelpBrowser" name="textBrowser"/>
|
<widget class="HelpBrowser" name="textBrowser"/>
|
||||||
</widget>
|
</widget>
|
||||||
</item>
|
</item>
|
||||||
<item>
|
|
||||||
<widget class="QDialogButtonBox" name="buttonBox">
|
|
||||||
<property name="orientation">
|
|
||||||
<enum>Qt::Horizontal</enum>
|
|
||||||
</property>
|
|
||||||
<property name="standardButtons">
|
|
||||||
<set>QDialogButtonBox::Close</set>
|
|
||||||
</property>
|
|
||||||
</widget>
|
|
||||||
</item>
|
|
||||||
</layout>
|
</layout>
|
||||||
</widget>
|
</widget>
|
||||||
<customwidgets>
|
<customwidgets>
|
||||||
|
|
@ -73,38 +63,5 @@
|
||||||
</customwidget>
|
</customwidget>
|
||||||
</customwidgets>
|
</customwidgets>
|
||||||
<resources/>
|
<resources/>
|
||||||
<connections>
|
<connections/>
|
||||||
<connection>
|
|
||||||
<sender>buttonBox</sender>
|
|
||||||
<signal>accepted()</signal>
|
|
||||||
<receiver>HelpDialog</receiver>
|
|
||||||
<slot>accept()</slot>
|
|
||||||
<hints>
|
|
||||||
<hint type="sourcelabel">
|
|
||||||
<x>248</x>
|
|
||||||
<y>254</y>
|
|
||||||
</hint>
|
|
||||||
<hint type="destinationlabel">
|
|
||||||
<x>157</x>
|
|
||||||
<y>274</y>
|
|
||||||
</hint>
|
|
||||||
</hints>
|
|
||||||
</connection>
|
|
||||||
<connection>
|
|
||||||
<sender>buttonBox</sender>
|
|
||||||
<signal>rejected()</signal>
|
|
||||||
<receiver>HelpDialog</receiver>
|
|
||||||
<slot>reject()</slot>
|
|
||||||
<hints>
|
|
||||||
<hint type="sourcelabel">
|
|
||||||
<x>316</x>
|
|
||||||
<y>260</y>
|
|
||||||
</hint>
|
|
||||||
<hint type="destinationlabel">
|
|
||||||
<x>286</x>
|
|
||||||
<y>274</y>
|
|
||||||
</hint>
|
|
||||||
</hints>
|
|
||||||
</connection>
|
|
||||||
</connections>
|
|
||||||
</ui>
|
</ui>
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue