Doc: Avoid creating the qqmlintegration.h and qqml.h proxy pages

QDoc allows positioning some amount of documentation under certain pages
by use of the "\relates" command.

The "\relates" command takes an argument that represents a name and
tries to find where the documentation should be positioned in the
output, based on that name.

When the provided name doesn't refer to anything that QDoc is aware of
in the current project, a "proxy page" will be created to hold the
documentation.

The "qqmlintegration.h" header is documented as an header and its
generated page was intended to be used to collect the documentation for
a series of elements that the header exports.

Nonetheless, while the header page itself was created while, the
elements that were intended to be collected where insted positioned
under a similarly named proxy page.

The issues stemmed from the "\headerfile" command using the
"<qqmlintegration.h>" name to refer to the header and the relevant
relates command using the "qqmlintegration.h" name to refer to the same,
with the two names differing in the usage of the surrounding angle
brackets.

To avoid creating a proxy page, and instead correctly collecting the
relevant documentation under the header documentation page, the name
usage was synchronized by changing the relevant "\relates" command to
refer to "<qqmlintegration.h>".

A similar issue existes for the "qqml.h" headerfile and a similar
solution was applied to solve the issue.

Pick-to: 6.9 6.8
Fixes: QTBUG-136037
Change-Id: I3bf1aa97648c0a94acb7a0de5f5fbbaeb6a81c7b
Reviewed-by: Sami Shalayel <[email protected]>

2 files changed, 48 insertions, 48 deletions

diff --git a/src/qml/doc/src/cppintegration/macros.qdoc b/src/qml/doc/src/cppintegration/macros.qdoc
index 8137adc986..6acd73ad8c 100644
--- a/src/qml/doc/src/cppintegration/macros.qdoc
+++ b/src/qml/doc/src/cppintegration/macros.qdoc
@@ -14,7 +14,7 @@
 
 /*!
   \macro QML_ELEMENT
-  \relates qqmlintegration.h
+  \relates <qqmlintegration.h>
 
   Declares the enclosing type or namespace to be available in QML, using its
   class or namespace name as the QML element name.
@@ -108,7 +108,7 @@
 
 /*!
   \macro QML_NAMED_ELEMENT(name)
-  \relates qqmlintegration.h
+  \relates <qqmlintegration.h>
 
   Declares the enclosing type or namespace to be available in QML, using \a name
   as the element name. Otherwise behaves the same as QML_ELEMENT.
@@ -128,7 +128,7 @@
 
 /*!
   \macro QML_ANONYMOUS
-  \relates qqmlintegration.h
+  \relates <qqmlintegration.h>
 
   Declares the enclosing type to be available, but anonymous in QML. The type
   cannot be created or used to declare properties in QML, but when passed from
@@ -140,7 +140,7 @@
 
 /*!
   \macro QML_INTERFACE
-  \relates qqmlintegration.h
+  \relates <qqmlintegration.h>
 
   This macro registers the enclosing C++ type in the QML system as an interface.
 
@@ -177,7 +177,7 @@
 
 /*!
   \macro QML_IMPLEMENTS_INTERFACES(interfaces)
-  \relates qqmlintegration.h
+  \relates <qqmlintegration.h>
 
   This macro tells Qt which QML \a interfaces the class implements.
   This macro should only be used for interfacing with classes using \l QML_INTERFACE, use \l Q_INTERFACES otherwise.
@@ -189,7 +189,7 @@
 
 /*!
   \macro QML_UNCREATABLE(reason)
-  \relates qqmlintegration.h
+  \relates <qqmlintegration.h>
 
   Declares that the enclosing type shall not be creatable from QML. This takes
   effect if the type is available in QML, by having a \l QML_ELEMENT or
@@ -208,7 +208,7 @@
 
 /*!
   \macro QML_SINGLETON
-  \relates qqmlintegration.h
+  \relates <qqmlintegration.h>
 
   Declares the enclosing type to be a singleton in QML. This only takes effect
   if the type is a \l Q_OBJECT and is available in QML (by having a
@@ -352,7 +352,7 @@
 
 /*!
   \macro QML_ADDED_IN_VERSION(MAJOR, MINOR)
-  \relates qqmlintegration.h
+  \relates <qqmlintegration.h>
 
   Declares that the enclosing type or namespace was added in the specified
   \a{MAJOR}.\a{MINOR} version. The version is assumed to be in line with any
@@ -371,7 +371,7 @@
 
 /*!
   \macro QML_ADDED_IN_MINOR_VERSION(VERSION)
-  \relates qqmlintegration.h
+  \relates <qqmlintegration.h>
   \deprecated [6.7] Use QML_ADDED_IN_VERSION and specify the full version
 
   Declares that the enclosing type or namespace was added in the specified minor
@@ -392,7 +392,7 @@
 
 /*!
   \macro QML_REMOVED_IN_VERSION(MAJOR, MINOR)
-  \relates qqmlintegration.h
+  \relates <qqmlintegration.h>
 
   Declares that the enclosing type or namespace was removed in the specified
   \a{MAJOR}.\a{MINOR} version. This is primarily useful when replacing the
@@ -411,7 +411,7 @@
 
 /*!
   \macro QML_REMOVED_IN_MINOR_VERSION(VERSION)
-  \relates qqmlintegration.h
+  \relates <qqmlintegration.h>
   \deprecated [6.7] Use QML_REMOVED_IN_VERSION and specify the full version
 
   Declares that the enclosing type or namespace was removed in the specified
@@ -431,7 +431,7 @@
 
 /*!
   \macro QML_EXTRA_VERSION(MAJOR, MINOR)
-  \relates qqmlintegration.h
+  \relates <qqmlintegration.h>
 
   Declare that the type should also be available in version \a{MAJOR}.\a{MINOR}.
   This can be helpful if a type should be available in multiple major versions.
@@ -456,7 +456,7 @@
 
 /*!
   \macro QML_ATTACHED(ATTACHED_TYPE)
-  \relates qqmlintegration.h
+  \relates <qqmlintegration.h>
 
   Declares that the enclosing type attaches \a ATTACHED_TYPE as an
   \l {Attached Properties and Attached Signal Handlers}
@@ -471,7 +471,7 @@
 
 /*!
   \macro QML_EXTENDED(EXTENDED_TYPE)
-  \relates qqmlintegration.h
+  \relates <qqmlintegration.h>
 
   Declares that the enclosing type uses \a EXTENDED_TYPE as an extension to
   provide further properties, methods, and enumerations in QML. This takes
@@ -488,7 +488,7 @@
 
 /*!
   \macro QML_EXTENDED_NAMESPACE(EXTENSION_NAMESPACE)
-  \relates qqmlintegration.h
+  \relates <qqmlintegration.h>
 
   Declares that the enclosing \b type uses \a EXTENSION_NAMESPACE as an extension to
   provide further enumerations in QML. This takes effect if the type
@@ -587,7 +587,7 @@
 
 /*!
   \macro QML_FOREIGN(FOREIGN_TYPE)
-  \relates qqmlintegration.h
+  \relates <qqmlintegration.h>
 
   Declares that any \l QML_ELEMENT, \l QML_NAMED_ELEMENT(), \l QML_ANONYMOUS,
   \l QML_INTERFACE, \l QML_UNCREATABLE(), \l QML_SINGLETON,
@@ -618,7 +618,7 @@
 
 /*!
   \macro QML_FOREIGN_NAMESPACE(FOREIGN_NAMESPACE)
-  \relates qqmlintegration.h
+  \relates <qqmlintegration.h>
 
   Declares that any \l QML_ELEMENT, \l QML_NAMED_ELEMENT(), \l QML_ANONYMOUS,
   \l QML_INTERFACE, \l QML_UNCREATABLE(), \l QML_SINGLETON,
@@ -637,7 +637,7 @@
 
 /*!
   \macro QML_UNAVAILABLE
-  \relates qqmlintegration.h
+  \relates <qqmlintegration.h>
 
   This macro declares the enclosing type to be unavailable in QML. It registers
   an internal dummy type called \c QQmlTypeNotAvailable as \l QML_FOREIGN()
@@ -689,7 +689,7 @@
 
 /*!
   \macro QML_SEQUENTIAL_CONTAINER(VALUE_TYPE)
-  \relates qqmlintegration.h
+  \relates <qqmlintegration.h>
 
   This macro declares the enclosing or referenced type as a sequential container
   managing a sequence of \a VALUE_TYPE elements. \a VALUE_TYPE can be an actual
@@ -751,7 +751,7 @@
 
 /*!
   \macro QML_VALUE_TYPE(name)
-  \relates qqmlintegration.h
+  \relates <qqmlintegration.h>
 
   Declares the enclosing type or namespace to be available in QML, using \a name
   as the name. The type has to be a value type and the name has to be lower case.
@@ -772,7 +772,7 @@
 /*!
   \macro QML_CONSTRUCTIBLE_VALUE
   \since 6.5
-  \relates qqmlintegration.h
+  \relates <qqmlintegration.h>
 
   Marks the surrounding value type as constructible. That is, any \l Q_INVOKABLE
   constructors of the type that take exactly one argument can be used when
@@ -831,7 +831,7 @@
 /*!
   \macro QML_STRUCTURED_VALUE
   \since 6.5
-  \relates qqmlintegration.h
+  \relates <qqmlintegration.h>
 
   Marks the surrounding value type as structured. Structured value types can
   and will preferably be constructed property-by-property from a JavaScript
diff --git a/src/qml/qml/qqml.cpp b/src/qml/qml/qqml.cpp
index fc4f98eae7..0dcd6a852f 100644
--- a/src/qml/qml/qqml.cpp
+++ b/src/qml/qml/qqml.cpp
@@ -136,7 +136,7 @@ QObject *qmlAttachedPropertiesObject(QObject *object, QQmlAttachedPropertiesFunc
 }
 
 /*!
-    \relates qqml.h
+    \relates <qqml.h>
 
     This function returns the extension object that belongs to \a base, if there is any.
     Otherwise it returns \c nullptr.
@@ -222,7 +222,7 @@ QMetaType QQmlPrivate::compositeListMetaType(
 }
 
 /*!
-  \relates qqml.h
+  \relates <qqml.h>
   \since 5.8
 
   This function registers the \a staticMetaObject and its extension
@@ -297,7 +297,7 @@ int qmlRegisterUncreatableMetaObject(const QMetaObject &staticMetaObject,
 }
 
 /*!
-  \relates qqml.h
+  \relates <qqml.h>
 
   Clears all stored type registrations, such as those produced with \l qmlRegisterType().
 
@@ -314,7 +314,7 @@ void qmlClearTypeRegistrations() // Declared in qqml.h
 }
 
 /*!
-  \relates qqml.h
+  \relates <qqml.h>
 
   This function protects a module from further modification. This can be used
   to prevent other plugins from injecting types into your module. It can also
@@ -349,7 +349,7 @@ bool qmlProtectModule(const char *uri, int majVersion)
 
 /*!
   \since 5.9
-  \relates qqml.h
+  \relates <qqml.h>
 
   This function registers a module in a particular \a uri with a version specified
   in \a versionMajor and \a versionMinor.
@@ -384,7 +384,7 @@ static QTypeRevision resolveModuleVersion(int moduleMajor)
 
 /*!
  * \enum QQmlModuleImportSpecialVersions
- * \relates qqml.h
+ * \relates <qqml.h>
  *
  * Defines some special values that can be passed to the version arguments of
  * qmlRegisterModuleImport() and qmlUnregisterModuleImport().
@@ -403,7 +403,7 @@ static QTypeRevision resolveModuleVersion(int moduleMajor)
  */
 
 /*!
- * \relates qqml.h
+ * \relates <qqml.h>
  * Registers a qmldir-import for module \a uri of major version \a moduleMajor.
  *
  * This has the same effect as an \c import statement in a qmldir file: Whenever
@@ -452,7 +452,7 @@ void qmlRegisterModuleImport(const char *uri, int moduleMajor,
 
 
 /*!
- * \relates qqml.h
+ * \relates <qqml.h>
  * Removes a module import previously registered with qmlRegisterModuleImport()
  *
  * Calling this function makes sure that \a import of version
@@ -472,7 +472,7 @@ void qmlUnregisterModuleImport(const char *uri, int moduleMajor,
 
 /*!
   \since 5.12
-  \relates qqml.h
+  \relates <qqml.h>
 
   Returns the QML type id of a type that was registered with the
   name \a qmlName in a particular \a uri and a version specified in \a
@@ -1069,7 +1069,7 @@ QList<QTypeRevision> QQmlPrivate::revisionClassInfos(const QMetaObject *metaObje
 }
 
 /*!
-  \relates qqml.h
+  \relates <qqml.h>
 
   This function registers a type in the QML system with the name \a qmlName, in the type namespace imported from \a uri having the
   version number composed from \a versionMajor and \a versionMinor, but any attempt to instantiate the type
@@ -3078,14 +3078,14 @@ void AOTCompiledContext::initCallValueLookup(
 
 /*!
   \macro QML_DECLARE_TYPE()
-  \relates qqml.h
+  \relates <qqml.h>
 
   Equivalent to \c Q_DECLARE_METATYPE(TYPE *) and \c Q_DECLARE_METATYPE(QQmlListProperty<TYPE>)
 */
 
 /*!
   \macro QML_DECLARE_TYPEINFO(Type,Flags)
-  \relates qqml.h
+  \relates <qqml.h>
 
   Declares additional properties of the given \a Type as described by the
   specified \a Flags.
@@ -3098,7 +3098,7 @@ void AOTCompiledContext::initCallValueLookup(
 
 /*!
   \fn template <typename T> int qmlRegisterType(const char *uri, int versionMajor, int versionMinor, const char *qmlName)
-  \relates qqml.h
+  \relates <qqml.h>
 
   This template function registers the C++ type in the QML system with
   the name \a qmlName, in the library imported from \a uri having the
@@ -3151,7 +3151,7 @@ void AOTCompiledContext::initCallValueLookup(
 
 /*!
   \fn template<typename T, int metaObjectRevision> int qmlRegisterRevision(const char *uri, int versionMajor, int versionMinor)
-  \relates qqml.h
+  \relates <qqml.h>
 
   This template function registers the specified revision of a C++ type in the QML system with
   the library imported from \a uri having the version number composed
@@ -3170,7 +3170,7 @@ void AOTCompiledContext::initCallValueLookup(
 
 /*!
   \fn template <typename T> int qmlRegisterUncreatableType(const char *uri, int versionMajor, int versionMinor, const char *qmlName, const QString& message)
-  \relates qqml.h
+  \relates <qqml.h>
 
   This template function registers the C++ type in the QML system with
   the name \a qmlName, in the library imported from \a uri having the
@@ -3189,7 +3189,7 @@ void AOTCompiledContext::initCallValueLookup(
 
 /*!
   \fn template <typename T, typename E> int qmlRegisterExtendedType(const char *uri, int versionMajor, int versionMinor, const char *qmlName)
-  \relates qqml.h
+  \relates <qqml.h>
 
   This template function registers the C++ type and its extension object in the
   QML system with the name \a qmlName in the library imported from \a uri having
@@ -3203,7 +3203,7 @@ void AOTCompiledContext::initCallValueLookup(
 
 /*!
   \fn template <typename T, typename E> int qmlRegisterExtendedUncreatableType(const char *uri, int versionMajor, int versionMinor, const char *qmlName, const QString& reason)
-  \relates qqml.h
+  \relates <qqml.h>
 
   This template function registers the C++ type and its extension
   in the QML system with the name \a qmlName in the library imported
@@ -3224,7 +3224,7 @@ void AOTCompiledContext::initCallValueLookup(
 
 /*!
   \fn int qmlRegisterCustomExtendedType(const char *uri, int versionMajor, int versionMinor, const char *qmlName, QQmlCustomParser *parser)
-  \relates qqml.h
+  \relates <qqml.h>
   \internal
 
   This template function registers the C++ type and its extension
@@ -3241,7 +3241,7 @@ void AOTCompiledContext::initCallValueLookup(
 
 /*!
   \fn template <typename T> int qmlRegisterAnonymousType(const char *uri, int versionMajor)
-  \relates qqml.h
+  \relates <qqml.h>
 
   This template function registers the C++ type in the QML system as an anonymous type. The
   resulting QML type does not have a name. Therefore, instances of this type cannot be created from
@@ -3325,7 +3325,7 @@ void AOTCompiledContext::initCallValueLookup(
 
 /*!
     \fn int qmlRegisterInterface(const char *typeName)
-    \relates qqml.h
+    \relates <qqml.h>
 
     This template function registers the C++ type in the QML system
     under the name \a typeName.
@@ -3360,7 +3360,7 @@ void AOTCompiledContext::initCallValueLookup(
 
 /*!
    \fn int qmlRegisterSingletonType(const char *uri, int versionMajor, int versionMinor, const char *typeName, std::function<QJSValue(QQmlEngine *, QJSEngine *)> callback)
-   \relates qqml.h
+   \relates <qqml.h>
 
    This function may be used to register a singleton type provider \a callback in a particular \a uri
    and \a typeName with a version specified in \a versionMajor and \a versionMinor.
@@ -3419,7 +3419,7 @@ void AOTCompiledContext::initCallValueLookup(
 
 /*!
     \fn template<typename T> QObject *qmlAttachedPropertiesObject(const QObject *attachee, bool create)
-    \relates qqml.h
+    \relates <qqml.h>
 
     The form of this template function is:
 
@@ -3441,7 +3441,7 @@ void AOTCompiledContext::initCallValueLookup(
 
 /*!
    \fn template <typename T> int qmlRegisterSingletonType(const char *uri, int versionMajor, int versionMinor, const char *typeName, std::function<QObject*(QQmlEngine *, QJSEngine *)> callback)
-   \relates qqml.h
+   \relates <qqml.h>
 
    This function may be used to register a singleton type provider \a callback in a particular \a uri
    and \a typeName with a version specified in \a versionMajor and \a versionMinor.
@@ -3535,7 +3535,7 @@ void AOTCompiledContext::initCallValueLookup(
 
 /*!
    \fn int qmlRegisterSingletonType(const QUrl &url, const char *uri, int versionMajor, int versionMinor, const char *qmlName)
-   \relates qqml.h
+   \relates <qqml.h>
 
    This function may be used to register a singleton type with the name \a qmlName, in the library imported from \a uri having
    the version number composed from \a versionMajor and \a versionMinor. The type is defined by the QML file located at \a url.
@@ -3583,7 +3583,7 @@ void AOTCompiledContext::initCallValueLookup(
 
 /*!
    \fn int qmlRegisterSingletonInstance(const char *uri, int versionMajor, int versionMinor, const char *typeName, QObject *cppObject)
-   \relates qqml.h
+   \relates <qqml.h>
    \since 5.14
 
    This function is used to register a singleton object \a cppObject, with a
@@ -3679,7 +3679,7 @@ void AOTCompiledContext::initCallValueLookup(
 
 /*!
   \fn int qmlRegisterType(const QUrl &url, const char *uri, int versionMajor, int versionMinor, const char *qmlName);
-  \relates qqml.h
+  \relates <qqml.h>
 
   This function registers a type in the QML system with the name \a qmlName, in the library imported from \a uri having the
   version number composed from \a versionMajor and \a versionMinor. The type is defined by the QML file located at \a url. The