aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@qt.io>2022-07-08 15:06:17 +0200
committerLeena Miettinen <riitta-leena.miettinen@qt.io>2022-07-12 07:41:03 +0000
commitff7b543b02f315f06d1f3255971aac1edbea526a (patch)
tree7c9fd2c7ea32f76a4ab5872a21a064a8db7d6c9c
parent89be4d7d17e7dc3eeae971e336aec8a25d9fc2e9 (diff)
Doc: Remove info about old way of marking syntax errors
Remove some redundancy by only describing annotations because Clang is now used by default. Task-number: QTCREATORBUG-27560 Change-Id: I02a950eac827f36575ab3bd60be9348c4b642824 Reviewed-by: Eike Ziller <eike.ziller@qt.io>
-rw-r--r--doc/qtcreator/images/qtcreator-options-text-editor-display.pngbin14533 -> 10742 bytes
-rw-r--r--doc/qtcreator/images/qtcreator-qml-js-editing.pngbin0 -> 5888 bytes
-rw-r--r--doc/qtcreator/images/qtcreator-semanticerror-clang.pngbin33662 -> 0 bytes
-rw-r--r--doc/qtcreator/images/qtcreator-semanticerror.pngbin9491 -> 22255 bytes
-rw-r--r--doc/qtcreator/images/qtcreator-syntaxerror-clang.pngbin31551 -> 0 bytes
-rw-r--r--doc/qtcreator/images/qtcreator-syntaxerror.pngbin9802 -> 22392 bytes
-rw-r--r--doc/qtcreator/images/qtcreator-typo-clang.pngbin52930 -> 19902 bytes
-rw-r--r--doc/qtcreator/src/editors/creator-code-syntax.qdoc42
8 files changed, 14 insertions, 28 deletions
diff --git a/doc/qtcreator/images/qtcreator-options-text-editor-display.png b/doc/qtcreator/images/qtcreator-options-text-editor-display.png
index d49884ae62..c00104e3b6 100644
--- a/doc/qtcreator/images/qtcreator-options-text-editor-display.png
+++ b/doc/qtcreator/images/qtcreator-options-text-editor-display.png
Binary files differ
diff --git a/doc/qtcreator/images/qtcreator-qml-js-editing.png b/doc/qtcreator/images/qtcreator-qml-js-editing.png
new file mode 100644
index 0000000000..731c97f1c2
--- /dev/null
+++ b/doc/qtcreator/images/qtcreator-qml-js-editing.png
Binary files differ
diff --git a/doc/qtcreator/images/qtcreator-semanticerror-clang.png b/doc/qtcreator/images/qtcreator-semanticerror-clang.png
deleted file mode 100644
index 9980485832..0000000000
--- a/doc/qtcreator/images/qtcreator-semanticerror-clang.png
+++ /dev/null
Binary files differ
diff --git a/doc/qtcreator/images/qtcreator-semanticerror.png b/doc/qtcreator/images/qtcreator-semanticerror.png
index e6920b98ca..72edb4744c 100644
--- a/doc/qtcreator/images/qtcreator-semanticerror.png
+++ b/doc/qtcreator/images/qtcreator-semanticerror.png
Binary files differ
diff --git a/doc/qtcreator/images/qtcreator-syntaxerror-clang.png b/doc/qtcreator/images/qtcreator-syntaxerror-clang.png
deleted file mode 100644
index 8beee1832f..0000000000
--- a/doc/qtcreator/images/qtcreator-syntaxerror-clang.png
+++ /dev/null
Binary files differ
diff --git a/doc/qtcreator/images/qtcreator-syntaxerror.png b/doc/qtcreator/images/qtcreator-syntaxerror.png
index 2f8916ce3b..1561ef7ac2 100644
--- a/doc/qtcreator/images/qtcreator-syntaxerror.png
+++ b/doc/qtcreator/images/qtcreator-syntaxerror.png
Binary files differ
diff --git a/doc/qtcreator/images/qtcreator-typo-clang.png b/doc/qtcreator/images/qtcreator-typo-clang.png
index 3e3ad7daea..76722d658e 100644
--- a/doc/qtcreator/images/qtcreator-typo-clang.png
+++ b/doc/qtcreator/images/qtcreator-typo-clang.png
Binary files differ
diff --git a/doc/qtcreator/src/editors/creator-code-syntax.qdoc b/doc/qtcreator/src/editors/creator-code-syntax.qdoc
index 268a721838..34287e1ff0 100644
--- a/doc/qtcreator/src/editors/creator-code-syntax.qdoc
+++ b/doc/qtcreator/src/editors/creator-code-syntax.qdoc
@@ -31,35 +31,25 @@
\title Checking Code Syntax
As you write code, \QC checks code syntax. When \QC spots a syntax error in
- your code it underlines it and shows error details when you move the mouse
- pointer over the error. Similarly, when you are working on an instance of a
- JavaScript object notation (JSON) entity, \QC underlines errors in JSON data
- structure.
+ your code, it underlines it, displays an icon, and shows error details when
+ you move the mouse pointer over the error or the icon. If a fix is available,
+ you can apply it by clicking \inlineimage icons/refactormarker.png
+ .
+
+ Similarly, when you are working on an instance of a JavaScript object
+ notation (JSON) entity, \QC underlines errors in the JSON data structure.
\if defined(qtcreator)
- In the following screenshot, \QC points out an error, because a semicolon is
+ In the following screenshot, \QC annotates an error because a semicolon is
missing at the end of the line:
\image qtcreator-syntaxerror.png
- In the following screenshot, \QC issues a warning, because the variable is
+ In the following screenshot, \QC issues a warning because the variable is
not used:
\image qtcreator-semanticerror.png
- To modify the colors used for underlining errors and warnings, select
- \uicontrol Edit > \uicontrol Preferences > \uicontrol {Text Editor} >
- \uicontrol {Font & Colors} > \uicontrol Copy, and select new colors for
- \uicontrol Error and \uicontrol Warning.
-
- \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 icons/refactormarker.png
- icon and pressing \key Enter.
-
In the following screenshot, a Qt class name contains a typo:
\image qtcreator-typo-clang.png
@@ -69,14 +59,10 @@
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 screenshot, the variable is not used.
-
- \image qtcreator-semanticerror-clang.png
+ To modify the colors used for underlining errors and warnings, select
+ \uicontrol Edit > \uicontrol Preferences > \uicontrol {Text Editor} >
+ \uicontrol {Font & Colors} > \uicontrol Copy, and select new colors for
+ \uicontrol Error and \uicontrol Warning.
\else
In addition to underlining, errors and warnings are marked with icons and
@@ -87,7 +73,7 @@
\image qml-syntax-check.png
- \section2 Specifying Line Annotation Positions
+ \section1 Specifying Line Annotation Positions
To specify the position where the annotations are displayed, select
\uicontrol Edit > \uicontrol Preferences > \uicontrol {Text Editor} >