Doc: Describe new ways of marking code errors when using Clang

Change-Id: I9b2d8ee52e83c60b7c6d46d2b5e8e830536e6bdb
Reviewed-by: Nikolai Kosjar <nikolai.kosjar@qt.io>
This commit is contained in:
Leena Miettinen
2017-07-24 13:22:39 +02:00
parent b4ca318383
commit 9652e85b3d
3 changed files with 26 additions and 2 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 33 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 31 KiB

View File

@@ -187,11 +187,35 @@
\endlist
In addition, you can run static checks on the QML and JavaScript code in
your project to find common problems.
When using the Clang code model, errors and warnings are additionally marked
with icons and annotated. If a \l{http://clang.llvm.org/diagnostics.html}
{Clang fix-it} is available, you can execute it by clicking the
\inlineimage refactormarker.png
icon and pressing \key Enter.
In the following figure, a semicolon is missing at the end of the
line.
\image qtcreator-syntaxerror-clang.png
In the following figure, the variable is not used.
\image qtcreator-semanticerror-clang.png
To specify the position where the annotations are displayed, select
\uicontrol Tools > \uicontrol Options > \uicontrol {Text Editor} >
\uicontrol Display > \uicontrol {Annotations next to lines}, and then
select whether to display the annotations directly next to the code,
aligned to the right of the code, or in the right margin.
If you hide the annotations by deselecting the check box, you can move the
mouse pointer over an icon to view them.
\section1 Checking JSON Data Structure
You can run static checks on the QML and JavaScript code in
your project to find common problems.
\QC validates instances of JSON entities against
\l{http://tools.ietf.org/html/draft-zyp-json-schema-03}
{A JSON Media Type for Describing the Structure and Meaning of JSON Documents}.