diff --git a/man/manual.docbook b/man/manual.docbook index e1837b5a8..75fd9cf26 100644 --- a/man/manual.docbook +++ b/man/manual.docbook @@ -175,6 +175,33 @@ Checking path/file2.cpp... like this can be used: cppcheck -DDEBUG=1 -D__cplusplus path + + An alternative for -D is to use #error. + + #if LIB_VERSION <= 3 +#error "lib version must be greater than 3" +#endif + + Using #error instead of -D have some advantages: + + + + the compiler will not be able to compile the code when invalid + defines are given. So #error makes your source code + safer/better. + + + + Cppcheck will check all valid configurations instead of a single + configuration. + + + + This information is added to the source code which means you + don't need to provide this information to Cppcheck (makes it simpler + to use Cppcheck) + + @@ -442,7 +469,73 @@ Options: ./cppcheck gui/test.cpp --xml 2> err.xml htmlreport/cppcheck-htmlreport --file=err.xml --report-dir=test1 --source-dir=. + - + + Graphical user interface + +
+ Introduction + + A Cppcheck GUI is available. + + The main screen is shown immediately when the GUI is + started. +
+ +
+ Check source code + + Use the Check menu. +
+ +
+ Inspecting results + + The results are shown in a list. + + You can show/hide certain types of messages through the + View menu. + + Results can be saved to an xml file that can later be opened. See + Save results to file and Open + XML. +
+ +
+ Settings + + The language can be changed at any time by using the + Language menu. + + More settings are available in + Edit>Preferences. +
+ +
+ Project files + + The project files are used to store project specific settings. + These settings are: + + + + include folders + + + + preprocessor defines + + + + It isn't recommended to provide the paths to the standard C/C++ + headers - Cppcheck has internal knowledge about ANSI C/C++ and it isn't + recommended that this known functionality is redefined. But feel free to + try it. + + As you can read in chapter 3 in this manual the default is that + Cppcheck checks all configurations. So only provide preprocessor defines + if you want to limit the checking. +