File: walkthrough.html

package info (click to toggle)
cppcheck 2.18.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 26,132 kB
  • sloc: cpp: 268,935; python: 20,890; ansic: 8,090; sh: 1,045; makefile: 1,008; xml: 1,005; cs: 291
file content (69 lines) | stat: -rw-r--r-- 2,049 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
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 &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>