forked from qt-creator/qt-creator
Doc: Add info about copy and ignore actions in syntax check tooltips
Users can select buttons for copying and ignoring diagnostics in tooltip popups displayed by the Clang code model. They can also click a link to move to the line annotation options. Change-Id: Ie98a8f853a22d902e89a1764a0aff28f8e180797 Reviewed-by: Marco Bubke <marco.bubke@qt.io>
This commit is contained in:
BIN
doc/images/qtcreator-typo-clang.png
Normal file
BIN
doc/images/qtcreator-typo-clang.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 52 KiB |
@@ -1,6 +1,6 @@
|
||||
/****************************************************************************
|
||||
**
|
||||
** Copyright (C) 2018 The Qt Company Ltd.
|
||||
** Copyright (C) 2019 The Qt Company Ltd.
|
||||
** Contact: https://www.qt.io/licensing/
|
||||
**
|
||||
** This file is part of the Qt Creator documentation.
|
||||
@@ -41,27 +41,38 @@
|
||||
\list
|
||||
\li Syntax errors are underlined in red.
|
||||
|
||||
In the following figure, a semicolon is missing at the end of the
|
||||
line.
|
||||
In the following screenshot, a semicolon is missing at the end
|
||||
of the line.
|
||||
\image qtcreator-syntaxerror.png
|
||||
\li Semantic errors and warnings are underlined in olive.
|
||||
|
||||
In the following figure, the variable is not used.
|
||||
In the following screenshot, the variable is not used.
|
||||
\image qtcreator-semanticerror.png
|
||||
\endlist
|
||||
|
||||
\section1 Viewing Annotations
|
||||
|
||||
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
|
||||
In the following screenshot, a Qt class name contains a typo:
|
||||
|
||||
\image qtcreator-typo-clang.png
|
||||
|
||||
You can use the icons in the tooltip popup to copy the error or
|
||||
warning message to the clipboard or to ignore and hide it. Select
|
||||
the \uicontrol {Annotation Settings} link to specify the position
|
||||
of the line annotations.
|
||||
|
||||
In the following screenshot, a semicolon is missing at the end of the
|
||||
line.
|
||||
|
||||
\image qtcreator-syntaxerror-clang.png
|
||||
|
||||
In the following figure, the variable is not used.
|
||||
In the following screenshot, the variable is not used.
|
||||
|
||||
\image qtcreator-semanticerror-clang.png
|
||||
|
||||
@@ -74,6 +85,8 @@
|
||||
|
||||
\image qml-syntax-check.png
|
||||
|
||||
\section2 Specifying Line Annotation Positions
|
||||
|
||||
To specify the position where the annotations are displayed, select
|
||||
\uicontrol Tools > \uicontrol Options > \uicontrol {Text Editor} >
|
||||
\uicontrol Display > \uicontrol {Line annotations}, and then select
|
||||
|
Reference in New Issue
Block a user