aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSami Shalayel <sami.shalayel@qt.io>2024-09-13 19:35:28 +0200
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2024-09-27 04:04:43 +0000
commitc94caed5995c781ef2371e467e26db6bfdf73a53 (patch)
tree7a22b48ed7da06f2d54bd17da51fa302012cd438
parentdf6f76e1d04ca9ab7523ecae924c6d8205fbac62 (diff)
doc: add qmllint [warning category] to briefs
Add the warning category to the briefs, as a third column with the warning category can't be added to the page at qtqml/qmllint-warnings-and-errors.html. This makes it much easier for users to find the documentation for their warning. Change-Id: I5c1e8486277563edf3a634b400f05200001c4d47 Reviewed-by: Ulf Hermann <ulf.hermann@qt.io> (cherry picked from commit c54a3e2b57b606c56c98cc25c1f126bc63b5b6e2) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> (cherry picked from commit 8803cff8826f1e7d25a52ec85a305b8f5132012a)
-rw-r--r--src/qml/doc/src/qmllint/access-singleton-via-object.qdoc2
-rw-r--r--src/qml/doc/src/qmllint/alias-cycle.qdoc2
-rw-r--r--src/qml/doc/src/qmllint/attached-property-reuse.qdoc2
-rw-r--r--src/qml/doc/src/qmllint/deprecated.qdoc2
-rw-r--r--src/qml/doc/src/qmllint/duplicate-property-binding.qdoc2
-rw-r--r--src/qml/doc/src/qmllint/duplicated-name.qdoc2
-rw-r--r--src/qml/doc/src/qmllint/import.qdoc2
-rw-r--r--src/qml/doc/src/qmllint/incompatible-type.qdoc2
-rw-r--r--src/qml/doc/src/qmllint/inheritance-cycle.qdoc2
-rw-r--r--src/qml/doc/src/qmllint/invalid-lint-directive.qdoc2
-rw-r--r--src/qml/doc/src/qmllint/missing-enum-entry.qdoc2
-rw-r--r--src/qml/doc/src/qmllint/missing-property.qdoc2
-rw-r--r--src/qml/doc/src/qmllint/missing-type.qdoc2
-rw-r--r--src/qml/doc/src/qmllint/multiline-strings.qdoc2
-rw-r--r--src/qml/doc/src/qmllint/non-list-property.qdoc2
-rw-r--r--src/qml/doc/src/qmllint/read-only-property.qdoc2
-rw-r--r--src/qml/doc/src/qmllint/recursion-depth-errors.qdoc2
-rw-r--r--src/qml/doc/src/qmllint/required.qdoc2
-rw-r--r--src/qml/doc/src/qmllint/restricted-type.qdoc2
-rw-r--r--src/qml/doc/src/qmllint/signal-handler-parameters.qdoc2
-rw-r--r--src/qml/doc/src/qmllint/syntax.duplicate-ids.qdoc2
-rw-r--r--src/qml/doc/src/qmllint/syntax.id-quotation.qdoc2
-rw-r--r--src/qml/doc/src/qmllint/syntax.qdoc2
-rw-r--r--src/qml/doc/src/qmllint/top-level-component.qdoc2
-rw-r--r--src/qml/doc/src/qmllint/uncreatable-type.qdoc2
-rw-r--r--src/qml/doc/src/qmllint/unqualified.qdoc2
-rw-r--r--src/qml/doc/src/qmllint/unresolved-alias.qdoc2
-rw-r--r--src/qml/doc/src/qmllint/unresolved-type.qdoc2
-rw-r--r--src/qml/doc/src/qmllint/unused-imports.qdoc2
-rw-r--r--src/qml/doc/src/qmllint/use-proper-function.qdoc2
-rw-r--r--src/qml/doc/src/qmllint/var-used-before-declaration.qdoc2
-rw-r--r--src/qml/doc/src/qmllint/with.qdoc2
32 files changed, 32 insertions, 32 deletions
diff --git a/src/qml/doc/src/qmllint/access-singleton-via-object.qdoc b/src/qml/doc/src/qmllint/access-singleton-via-object.qdoc
index 3fd85ec13c..abb64a13d5 100644
--- a/src/qml/doc/src/qmllint/access-singleton-via-object.qdoc
+++ b/src/qml/doc/src/qmllint/access-singleton-via-object.qdoc
@@ -6,7 +6,7 @@
\ingroup qmllint-warnings-and-errors
\title Cannot access singleton as a property of an object
-\brief A singleton was incorrectly accessed.
+\brief [access-singleton-via-object] A singleton was incorrectly accessed.
\section1 Access singleton via object
diff --git a/src/qml/doc/src/qmllint/alias-cycle.qdoc b/src/qml/doc/src/qmllint/alias-cycle.qdoc
index 5dee379e76..d73f567ceb 100644
--- a/src/qml/doc/src/qmllint/alias-cycle.qdoc
+++ b/src/qml/doc/src/qmllint/alias-cycle.qdoc
@@ -6,7 +6,7 @@
\ingroup qmllint-warnings-and-errors
\title Alias cycle
-\brief Alias property is part of an alias cycle.
+\brief [alias-cycle] Alias property is part of an alias cycle.
\qmllintwarningcategory alias-cycle
diff --git a/src/qml/doc/src/qmllint/attached-property-reuse.qdoc b/src/qml/doc/src/qmllint/attached-property-reuse.qdoc
index f3c2f64bce..5358d88e07 100644
--- a/src/qml/doc/src/qmllint/attached-property-reuse.qdoc
+++ b/src/qml/doc/src/qmllint/attached-property-reuse.qdoc
@@ -6,7 +6,7 @@
\ingroup qmllint-warnings-and-errors
\title Attached property reuse
-\brief Attached type was initialized multiple times.
+\brief [attached-property-reuse] Attached type was initialized multiple times.
\qmllintwarningcategory attached-property-reuse
diff --git a/src/qml/doc/src/qmllint/deprecated.qdoc b/src/qml/doc/src/qmllint/deprecated.qdoc
index 0568e8bcd4..17247861fe 100644
--- a/src/qml/doc/src/qmllint/deprecated.qdoc
+++ b/src/qml/doc/src/qmllint/deprecated.qdoc
@@ -6,7 +6,7 @@
\ingroup qmllint-warnings-and-errors
\title Deprecated
-\brief A deprecated property or type was used.
+\brief [deprecated] A deprecated property or type was used.
\qmllintwarningcategory deprecated
diff --git a/src/qml/doc/src/qmllint/duplicate-property-binding.qdoc b/src/qml/doc/src/qmllint/duplicate-property-binding.qdoc
index 9a5ba801ad..0bd65c786a 100644
--- a/src/qml/doc/src/qmllint/duplicate-property-binding.qdoc
+++ b/src/qml/doc/src/qmllint/duplicate-property-binding.qdoc
@@ -6,7 +6,7 @@
\ingroup qmllint-warnings-and-errors
\title Duplicate bindings
-\brief A property was bound multiple times.
+\brief [duplicate-property-binding] A property was bound multiple times.
\qmllintwarningcategory duplicate-property-binding
diff --git a/src/qml/doc/src/qmllint/duplicated-name.qdoc b/src/qml/doc/src/qmllint/duplicated-name.qdoc
index 0f3f1a6826..86fbd5a065 100644
--- a/src/qml/doc/src/qmllint/duplicated-name.qdoc
+++ b/src/qml/doc/src/qmllint/duplicated-name.qdoc
@@ -6,7 +6,7 @@
\ingroup qmllint-warnings-and-errors
\title Duplicated name
-\brief Multiple signals or properties share the same name in the same Component.
+\brief [duplicated-name] Multiple signals or properties share the same name in the same Component.
\qmllintwarningcategory duplicated-name
diff --git a/src/qml/doc/src/qmllint/import.qdoc b/src/qml/doc/src/qmllint/import.qdoc
index e420f960dd..28a32566d1 100644
--- a/src/qml/doc/src/qmllint/import.qdoc
+++ b/src/qml/doc/src/qmllint/import.qdoc
@@ -6,7 +6,7 @@
\ingroup qmllint-warnings-and-errors
\title Warnings occurred while importing
-\brief The imported module was not found.
+\brief [import] The imported module was not found.
\qmllintwarningcategory import
diff --git a/src/qml/doc/src/qmllint/incompatible-type.qdoc b/src/qml/doc/src/qmllint/incompatible-type.qdoc
index f34a32452e..cdb2dcdacd 100644
--- a/src/qml/doc/src/qmllint/incompatible-type.qdoc
+++ b/src/qml/doc/src/qmllint/incompatible-type.qdoc
@@ -6,7 +6,7 @@
\ingroup qmllint-warnings-and-errors
\title Incompatible type
-\brief An object, value, or expression is used on an incompatible type.
+\brief [incompatible-type] An object, value, or expression is used on an incompatible type.
\qmllintwarningcategory incompatible-type
diff --git a/src/qml/doc/src/qmllint/inheritance-cycle.qdoc b/src/qml/doc/src/qmllint/inheritance-cycle.qdoc
index a615a4c4c9..59630c7828 100644
--- a/src/qml/doc/src/qmllint/inheritance-cycle.qdoc
+++ b/src/qml/doc/src/qmllint/inheritance-cycle.qdoc
@@ -6,7 +6,7 @@
\ingroup qmllint-warnings-and-errors
\title Inheritance cycle
-\brief A component inherits from itself.
+\brief [inheritance-cycle] A component inherits from itself.
\qmllintwarningcategory inheritance-cycle
diff --git a/src/qml/doc/src/qmllint/invalid-lint-directive.qdoc b/src/qml/doc/src/qmllint/invalid-lint-directive.qdoc
index 582c24ac00..57ff98e54a 100644
--- a/src/qml/doc/src/qmllint/invalid-lint-directive.qdoc
+++ b/src/qml/doc/src/qmllint/invalid-lint-directive.qdoc
@@ -6,7 +6,7 @@
\ingroup qmllint-warnings-and-errors
\title Invalid qmllint directives
-\brief Invalid qmllint comments.
+\brief [invalid-lint-directive] Invalid qmllint comments.
\qmllintwarningcategory invalid-lint-directive
diff --git a/src/qml/doc/src/qmllint/missing-enum-entry.qdoc b/src/qml/doc/src/qmllint/missing-enum-entry.qdoc
index ccaaeafcf6..325f0d4568 100644
--- a/src/qml/doc/src/qmllint/missing-enum-entry.qdoc
+++ b/src/qml/doc/src/qmllint/missing-enum-entry.qdoc
@@ -6,7 +6,7 @@
\ingroup qmllint-warnings-and-errors
\title Missing enum entry
-\brief Enum value is missing from its declaration.
+\brief [missing-enum-entry] Enum value is missing from its declaration.
\qmllintwarningcategory missing-enum-entry
diff --git a/src/qml/doc/src/qmllint/missing-property.qdoc b/src/qml/doc/src/qmllint/missing-property.qdoc
index e31450e61e..ade8615ce9 100644
--- a/src/qml/doc/src/qmllint/missing-property.qdoc
+++ b/src/qml/doc/src/qmllint/missing-property.qdoc
@@ -6,7 +6,7 @@
\ingroup qmllint-warnings-and-errors
\title Missing property
-\brief Binding a value to a non-existing property.
+\brief [missing-property] Binding a value to a non-existing property.
\qmllintwarningcategory missing-property
diff --git a/src/qml/doc/src/qmllint/missing-type.qdoc b/src/qml/doc/src/qmllint/missing-type.qdoc
index edee109a92..9b191942a4 100644
--- a/src/qml/doc/src/qmllint/missing-type.qdoc
+++ b/src/qml/doc/src/qmllint/missing-type.qdoc
@@ -6,7 +6,7 @@
\ingroup qmllint-warnings-and-errors
\title Missing type
-\brief A type used in a binding or alias was not found.
+\brief [missing-type] A type used in a binding or alias was not found.
\qmllintwarningcategory missing-type
diff --git a/src/qml/doc/src/qmllint/multiline-strings.qdoc b/src/qml/doc/src/qmllint/multiline-strings.qdoc
index 37db09e919..711b1a11ed 100644
--- a/src/qml/doc/src/qmllint/multiline-strings.qdoc
+++ b/src/qml/doc/src/qmllint/multiline-strings.qdoc
@@ -6,7 +6,7 @@
\ingroup qmllint-warnings-and-errors
\title Multiline strings
-\brief A string is spanning over multiple lines.
+\brief [multiline-strings] A string is spanning over multiple lines.
\qmllintwarningcategory multiline-strings
diff --git a/src/qml/doc/src/qmllint/non-list-property.qdoc b/src/qml/doc/src/qmllint/non-list-property.qdoc
index 84942830f5..1d79307505 100644
--- a/src/qml/doc/src/qmllint/non-list-property.qdoc
+++ b/src/qml/doc/src/qmllint/non-list-property.qdoc
@@ -6,7 +6,7 @@
\ingroup qmllint-warnings-and-errors
\title Non-list property
-\brief Multiple values were assigned to a non-list property.
+\brief [non-list-property] Multiple values were assigned to a non-list property.
\qmllintwarningcategory non-list-property
diff --git a/src/qml/doc/src/qmllint/read-only-property.qdoc b/src/qml/doc/src/qmllint/read-only-property.qdoc
index 1c0e3b49a5..e48dc68ca8 100644
--- a/src/qml/doc/src/qmllint/read-only-property.qdoc
+++ b/src/qml/doc/src/qmllint/read-only-property.qdoc
@@ -6,7 +6,7 @@
\ingroup qmllint-warnings-and-errors
\title Readonly property
-\brief A readonly property was written.
+\brief [read-only-property] A readonly property was written.
\section1 read-only-property
diff --git a/src/qml/doc/src/qmllint/recursion-depth-errors.qdoc b/src/qml/doc/src/qmllint/recursion-depth-errors.qdoc
index 65cf1b1fd0..517e061350 100644
--- a/src/qml/doc/src/qmllint/recursion-depth-errors.qdoc
+++ b/src/qml/doc/src/qmllint/recursion-depth-errors.qdoc
@@ -6,7 +6,7 @@
\ingroup qmllint-warnings-and-errors
\title Recursion depths errors
-\brief Qml statement or expression is too deeply nested.
+\brief [recursion-depth-errors] Qml statement or expression is too deeply nested.
\qmllintwarningcategory recursion-depth-errors
diff --git a/src/qml/doc/src/qmllint/required.qdoc b/src/qml/doc/src/qmllint/required.qdoc
index 7b3e066c5f..63e36c1b43 100644
--- a/src/qml/doc/src/qmllint/required.qdoc
+++ b/src/qml/doc/src/qmllint/required.qdoc
@@ -6,7 +6,7 @@
\ingroup qmllint-warnings-and-errors
\title Component is missing a required property
-\brief A component's required property was not bound.
+\brief [required] A component's required property was not bound.
\qmllintwarningcategory required
diff --git a/src/qml/doc/src/qmllint/restricted-type.qdoc b/src/qml/doc/src/qmllint/restricted-type.qdoc
index 7fd6068958..d2001bf255 100644
--- a/src/qml/doc/src/qmllint/restricted-type.qdoc
+++ b/src/qml/doc/src/qmllint/restricted-type.qdoc
@@ -6,7 +6,7 @@
\ingroup qmllint-warnings-and-errors
\title Restricted type
-\brief A restricted type was accessed.
+\brief [restricted-type] A restricted type was accessed.
\qmllintwarningcategory restricted-type
diff --git a/src/qml/doc/src/qmllint/signal-handler-parameters.qdoc b/src/qml/doc/src/qmllint/signal-handler-parameters.qdoc
index 789ff74f43..565c161752 100644
--- a/src/qml/doc/src/qmllint/signal-handler-parameters.qdoc
+++ b/src/qml/doc/src/qmllint/signal-handler-parameters.qdoc
@@ -6,7 +6,7 @@
\ingroup qmllint-warnings-and-errors
\title Signal handler parameters
-\brief The signal handler does not satisfy the signal types.
+\brief [signal-handler-parameters] The signal handler does not satisfy the signal types.
\qmllintwarningcategory signal-handler-parameters
diff --git a/src/qml/doc/src/qmllint/syntax.duplicate-ids.qdoc b/src/qml/doc/src/qmllint/syntax.duplicate-ids.qdoc
index b08df9742d..026f306c6b 100644
--- a/src/qml/doc/src/qmllint/syntax.duplicate-ids.qdoc
+++ b/src/qml/doc/src/qmllint/syntax.duplicate-ids.qdoc
@@ -6,7 +6,7 @@
\ingroup qmllint-warnings-and-errors
\title Duplicate id
-\brief An id is not unique.
+\brief [syntax.duplicate-ids] An id is not unique.
\qmllintwarningcategory syntax.duplicate-ids
diff --git a/src/qml/doc/src/qmllint/syntax.id-quotation.qdoc b/src/qml/doc/src/qmllint/syntax.id-quotation.qdoc
index d3484e0649..4a45b61e23 100644
--- a/src/qml/doc/src/qmllint/syntax.id-quotation.qdoc
+++ b/src/qml/doc/src/qmllint/syntax.id-quotation.qdoc
@@ -6,7 +6,7 @@
\ingroup qmllint-warnings-and-errors
\title Id quotation
-\brief Id has quotation marks.
+\brief [syntax.id-quotation] Id has quotation marks.
\qmllintwarningcategory syntax.id-quotation
diff --git a/src/qml/doc/src/qmllint/syntax.qdoc b/src/qml/doc/src/qmllint/syntax.qdoc
index 974f6215cd..895a556249 100644
--- a/src/qml/doc/src/qmllint/syntax.qdoc
+++ b/src/qml/doc/src/qmllint/syntax.qdoc
@@ -6,7 +6,7 @@
\ingroup qmllint-warnings-and-errors
\title Syntax
-\brief Various syntactic errors.
+\brief [syntax] Various syntactic errors.
\qmllintwarningcategory syntax
diff --git a/src/qml/doc/src/qmllint/top-level-component.qdoc b/src/qml/doc/src/qmllint/top-level-component.qdoc
index d2cf8b4e85..38a9e9ef9b 100644
--- a/src/qml/doc/src/qmllint/top-level-component.qdoc
+++ b/src/qml/doc/src/qmllint/top-level-component.qdoc
@@ -6,7 +6,7 @@
\ingroup qmllint-warnings-and-errors
\title Top level component
-\brief Root QML type is a component
+\brief [top-level-component] Root QML type is a component
\qmllintwarningcategory top-level-component
diff --git a/src/qml/doc/src/qmllint/uncreatable-type.qdoc b/src/qml/doc/src/qmllint/uncreatable-type.qdoc
index b2ef11b033..506911dc41 100644
--- a/src/qml/doc/src/qmllint/uncreatable-type.qdoc
+++ b/src/qml/doc/src/qmllint/uncreatable-type.qdoc
@@ -6,7 +6,7 @@
\ingroup qmllint-warnings-and-errors
\title Uncreatable type
-\brief Types that can't be created.
+\brief [uncreatable-type] Types that can't be created.
\qmllintwarningcategory uncreatable-type
diff --git a/src/qml/doc/src/qmllint/unqualified.qdoc b/src/qml/doc/src/qmllint/unqualified.qdoc
index 74728fd34b..53d425897d 100644
--- a/src/qml/doc/src/qmllint/unqualified.qdoc
+++ b/src/qml/doc/src/qmllint/unqualified.qdoc
@@ -6,7 +6,7 @@
\ingroup qmllint-warnings-and-errors
\title Unqualified
-\brief Accessing an outer scope without its id.
+\brief [unqualified] Accessing an outer scope without its id.
\qmllintwarningcategory unqualified
diff --git a/src/qml/doc/src/qmllint/unresolved-alias.qdoc b/src/qml/doc/src/qmllint/unresolved-alias.qdoc
index 4498e6ad2b..561651d83e 100644
--- a/src/qml/doc/src/qmllint/unresolved-alias.qdoc
+++ b/src/qml/doc/src/qmllint/unresolved-alias.qdoc
@@ -6,7 +6,7 @@
\ingroup qmllint-warnings-and-errors
\title Unresolved alias
-\brief Property of property alias was not found.
+\brief [unresolved-alias] Property of property alias was not found.
\qmllintwarningcategory unresolved-alias
diff --git a/src/qml/doc/src/qmllint/unresolved-type.qdoc b/src/qml/doc/src/qmllint/unresolved-type.qdoc
index af074ec867..f399550b38 100644
--- a/src/qml/doc/src/qmllint/unresolved-type.qdoc
+++ b/src/qml/doc/src/qmllint/unresolved-type.qdoc
@@ -6,7 +6,7 @@
\ingroup qmllint-warnings-and-errors
\title Unresolved type
-\brief A used type was not found.
+\brief [unresolved-type] A used type was not found.
This category contains following warnings:
\list
diff --git a/src/qml/doc/src/qmllint/unused-imports.qdoc b/src/qml/doc/src/qmllint/unused-imports.qdoc
index ee01318819..e504ed0c84 100644
--- a/src/qml/doc/src/qmllint/unused-imports.qdoc
+++ b/src/qml/doc/src/qmllint/unused-imports.qdoc
@@ -6,7 +6,7 @@
\ingroup qmllint-warnings-and-errors
\title Unused imports
-\brief Types of the imported module were not used.
+\brief [unused-imports] Types of the imported module were not used.
\qmllintwarningcategory unused-imports
diff --git a/src/qml/doc/src/qmllint/use-proper-function.qdoc b/src/qml/doc/src/qmllint/use-proper-function.qdoc
index 5028612afc..7d47ddce88 100644
--- a/src/qml/doc/src/qmllint/use-proper-function.qdoc
+++ b/src/qml/doc/src/qmllint/use-proper-function.qdoc
@@ -6,7 +6,7 @@
\ingroup qmllint-warnings-and-errors
\title Use proper function
-\brief Calling something that might not be a function.
+\brief [use-proper-function] Calling something that might not be a function.
\qmllintwarningcategory use-proper-function
diff --git a/src/qml/doc/src/qmllint/var-used-before-declaration.qdoc b/src/qml/doc/src/qmllint/var-used-before-declaration.qdoc
index 9bb76e8771..b505b246d8 100644
--- a/src/qml/doc/src/qmllint/var-used-before-declaration.qdoc
+++ b/src/qml/doc/src/qmllint/var-used-before-declaration.qdoc
@@ -6,7 +6,7 @@
\ingroup qmllint-warnings-and-errors
\title Var used before declaration
-\brief A JavaScript variable was used before its declaration.
+\brief [var-used-before-declaration] A JavaScript variable was used before its declaration.
\qmllintwarningcategory var-used-before-declaration
diff --git a/src/qml/doc/src/qmllint/with.qdoc b/src/qml/doc/src/qmllint/with.qdoc
index 8e3fb5089b..eed1788c96 100644
--- a/src/qml/doc/src/qmllint/with.qdoc
+++ b/src/qml/doc/src/qmllint/with.qdoc
@@ -6,7 +6,7 @@
\ingroup qmllint-warnings-and-errors
\title With
-\brief With statements are strongly discouraged in QML.
+\brief [with] With statements are strongly discouraged in QML.
\qmllintwarningcategory with