diff --git a/gui/help/images/walkthrough-analysis.png b/gui/help/images/walkthrough-analysis.png new file mode 100644 index 000000000..94efb2890 Binary files /dev/null and b/gui/help/images/walkthrough-analysis.png differ diff --git a/gui/help/images/walkthrough-import-project.png b/gui/help/images/walkthrough-import-project.png new file mode 100644 index 000000000..44b18e7f6 Binary files /dev/null and b/gui/help/images/walkthrough-import-project.png differ diff --git a/gui/help/images/walkthrough-library.png b/gui/help/images/walkthrough-library.png new file mode 100644 index 000000000..fbb5ae14d Binary files /dev/null and b/gui/help/images/walkthrough-library.png differ diff --git a/gui/help/images/walkthrough-new-project.png b/gui/help/images/walkthrough-new-project.png new file mode 100644 index 000000000..55bf7ce2f Binary files /dev/null and b/gui/help/images/walkthrough-new-project.png differ diff --git a/gui/help/images/walkthrough-toolbar-severities.png b/gui/help/images/walkthrough-toolbar-severities.png new file mode 100644 index 000000000..f06e3aa41 Binary files /dev/null and b/gui/help/images/walkthrough-toolbar-severities.png differ diff --git a/gui/help/images/walkthrough-warning-menu.png b/gui/help/images/walkthrough-warning-menu.png new file mode 100644 index 000000000..a1c5c97fa Binary files /dev/null and b/gui/help/images/walkthrough-warning-menu.png differ diff --git a/gui/help/index.html b/gui/help/index.html index b466002dc..57a466b0c 100644 --- a/gui/help/index.html +++ b/gui/help/index.html @@ -8,45 +8,6 @@

With the Cppcheck GUI you can analyze your code.

-

Quick walk through

- -

Step 1: Create a project.

- -

Create a new project.

- -

In the Paths and Defines tab, it is recommended that you import your project file at the top.

- -

In the Types and Functions tab, try to activate all 3rd party libraries you use (windows, posix, ...).

- -

In the Analysis tab, leave the default settings to start with.

- -

In the Warnings options tab, leave the default settings to start with.

- -

In the Addons tab, leave the default settings to start with.

- - -

Step 2: Analyze code.

- -

When the project file has been created, the analysis will start automatically.

- -

While analysis is performed in the background, you can investigate the warnings.

- - -

Step 3: Investigate warnings.

- -

In the toolbar you choose what types of warnings you want to see (error/warning/style/performance/portability/information).

- -

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.

- -

If you right click on warning(s) then you get a context menu.

- - -

Step 4: Configuration.

- -

It is possible to improve configuration to get better analysis. The automatic assumptions are conservative and through configuration those automatic assumptions can be avoided.

- -

TODO: library, contracts

- diff --git a/gui/help/online-help.qhp b/gui/help/online-help.qhp index 4bbe8074d..2af58d079 100644 --- a/gui/help/online-help.qhp +++ b/gui/help/online-help.qhp @@ -10,6 +10,7 @@
+
@@ -23,6 +24,13 @@ projectfiledialog.html standalone-analysis.html tagging.html + walkthrough.html + images/walkthrough-analysis.png + images/walkthrough-library.png + images/walkthrough-toolbar-severities.png + images/walkthrough-import-project.png + images/walkthrough-new-project.png + images/walkthrough-warning-menu.png diff --git a/gui/help/walkthrough.html b/gui/help/walkthrough.html new file mode 100644 index 000000000..9f27ce05f --- /dev/null +++ b/gui/help/walkthrough.html @@ -0,0 +1,69 @@ + + +Walk through + + + +

Quick walk through

+ +This is a quick and short walk through to get you started. + +

Step 1: Create a project.

+ +

Create a new project:

+ +
+ +

In the Paths and Defines tab, it is recommended that you import your +project file at the top.

+ +
+ +

In the Types and Functions tab, try to activate all 3rd party +libraries you use (windows, posix, ...).

+ +
+ +

In the Analysis tab, leave the default settings to start with.

+ +

In the Warnings options tab, leave the default settings to start +with.

+ +

In the Addons tab, leave the default settings to start with.

+ + +

Step 2: Analyze code.

+ +

When the project file has been created, the analysis will start +automatically.

+ +

While analysis is performed in the background, you can investigate the +results.

+ +
+ + +

Step 3: Investigate warnings.

+ +

In the toolbar you choose what types of warnings you want to see +(error/warning/style/performance/portability/information).

+ +
+ + +

All warnings are shown in a list. If you select a warning in the list, then +details about that warning is shown.

+ +

If you right click on warning(s) then you get a context menu.

+ +
+ +

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.

+ + + + diff --git a/gui/helpdialog.ui b/gui/helpdialog.ui index bc5ccc706..0fb74c6a1 100644 --- a/gui/helpdialog.ui +++ b/gui/helpdialog.ui @@ -53,16 +53,6 @@ - - - - Qt::Horizontal - - - QDialogButtonBox::Close - - - @@ -73,38 +63,5 @@ - - - buttonBox - accepted() - HelpDialog - accept() - - - 248 - 254 - - - 157 - 274 - - - - - buttonBox - rejected() - HelpDialog - reject() - - - 316 - 260 - - - 286 - 274 - - - - +