cppcheck/gui/help/walkthrough.html

70 lines
2.0 KiB
HTML
Raw Permalink Normal View History

2020-07-21 10:30:50 +02:00
<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 &quot;Hide&quot; and &quot;Suppress&quot; 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>