walkero
/
cppcheck
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity

GUI: online-help (severities)

This commit is contained in:
Daniel Marjamäki 2020-07-22 14:31:02 +02:00
parent 2fd44fa464
commit 5a99b81ed7
8 changed files with 53 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
gui/help/images/severities-error.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 809 B

BIN
gui/help/images/severities-information.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1006 B

BIN
gui/help/images/severities-performance.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 847 B

BIN
gui/help/images/severities-portability.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1.3 KiB

BIN
gui/help/images/severities-style.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1.2 KiB

BIN
gui/help/images/severities-warning.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 805 B

13
gui/help/online-help.qhp
View File

@ -8,14 +8,20 @@
<section title="Investigating warnings" ref="./investigating-warnings.html"/>
<section title="Preferences" ref="./preferences.html"/>
<section title="Project file dialog" ref="./projectfiledialog.html"/>
<section title="Severities" ref="./severities.html"/>
<section title="Standalone analysis" ref="./standalone-analysis.html"/>
<section title="Tagging" ref="./tagging.html"/>
<section title="Quick walk through" ref="./walkthrough.html"/>
</section>
</toc>
<keywords>
<keyword name="Error" ref="./severities.html"/>
<keyword name="Performance" ref="./severities.html"/>
<keyword name="Portability" ref="./severities.html"/>
<keyword name="Project" ref="./projectfiledialog.html"/>
<keyword name="Style" ref="./severities.html"/>
<keyword name="Tag" ref="./tagging.html"/>
<keyword name="Warning" ref="./severities.html"/>
</keywords>
<files>
<file>index.html</file>
@ -23,6 +29,13 @@
<file>investigating-warnings.html</file>
<file>preferences.html</file>
<file>projectfiledialog.html</file>
<file>severities.html</file>
<file>images/severities-error.png</file>
<file>images/severities-warning.png</file>
<file>images/severities-style.png</file>
<file>images/severities-performance.png</file>
<file>images/severities-portability.png</file>
<file>images/severities-information.png</file>
<file>standalone-analysis.html</file>
<file>tagging.html</file>
<file>walkthrough.html</file>

40
gui/help/severities.html Normal file
View File

@ -0,0 +1,40 @@
<html>
<head>
<title>Severities</title>
</head>
<body>
<h1>Severities</h1>
<h2>error</h2>
<img src="images/severities-error.png"><br>
used when bugs are found
<h2>warning</h2>
<img src="images/severities-warning.png"><br>
suggestions about defensive programming to prevent bugs
<h2>style</h2>
<img src="images/severities-style.png"><br>
stylistic issues related to code cleanup (unused functions, redundant code, constness, and such)
<h2>performance</h2>
<img src="images/severities-performance.png"><br>
Suggestions for making the code faster. These suggestions are only based on common knowledge. It is not certain you'll get any measurable difference in speed by fixing these messages.
<h2>portability</h2>
<img src="images/severities-portability.png"><br>
portability warnings. 64-bit portability. code might work different on different compilers. etc.
<h2>information</h2>
<img src="images/severities-information.png"><br>
Configuration problems. The recommendation is to only enable these during configuration.
</body>
</html>