AuroraMiddleware/qt5base-lts
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Doc: Fix documentation warnings for Qt GUI

Browse Source 
* Drop deprecation warnings for now-dropped items
* Use the 'qt6' define and a new \nothing doc macro to conditionally
  document items on Qt 6
* Add a custom module header for docs that pulls in also Vulkan headers
* Add \internal command for internal classes/functions
* Move QtGUI-related code snippets from widgets to gui docs

Change-Id: Ieb386b96631a49568d09059906d307c45c01d93a
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
This commit is contained in:
Topi Reinio 2020-08-01 00:33:49 +02:00
parent 00a1e5da7e
commit 239982901b
34 changed files with 106 additions and 104 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/global/macros.qdocconf
View File

@ -14,6 +14,7 @@ macro.macos = "macOS"
macro.menu = "\\b"
macro.oslash.HTML = "&oslash;"
macro.ouml.HTML = "&ouml;"
macro.nothing = "\\dontdocument ()"
macro.nullptr = "\\c{nullptr}"
macro.QA = "\\e{Qt Assistant}"
macro.QD = "\\e{Qt Designer}"

2
src/gui/accessible/qaccessible.cpp
View File

@ -1085,7 +1085,7 @@ QPair< int, int > QAccessible::qAccessibleTextBoundaryHelper(const QTextCursor &
relations, unless they are handled in a specific way such as in tree views.
It will typically return the labelled-by and label relations.
It is possible to filter the relations by using \a match.
It is possible to filter the relations by using the optional parameter.
It should never return itself.
\sa parent(), child()

10
src/gui/doc/QtGuiDoc Normal file
View File

@ -0,0 +1,10 @@
#include <QtGui/QtGui>
#include <QtGui/QVulkanDeviceFunctions>
#include <QtGui/QVulkanExtension>
#include <QtGui/QVulkanFunctions>
#include <QtGui/QVulkanInfoVector>
#include <QtGui/QVulkanInstance>
#include <QtGui/QVulkanLayer>
#include <QtGui/QVulkanWindow>
#include <QtGui/QVulkanWindowRenderer>

6
src/gui/doc/qtgui.qdocconf
View File

@ -1,6 +1,9 @@
include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)
include($QT_INSTALL_DOCS/config/exampleurl-qtbase.qdocconf)
includepaths += .
moduleheader = QtGuiDoc
project = QtGui
description = Qt GUI Reference Documentation
version = $QT_VERSION
@ -58,7 +61,8 @@ imagedirs += images \
../../../doc/src/images
# Included in qttestlib.qdocconf instead
excludefiles += ../kernel/qtestsupport_gui.cpp
excludefiles += ../kernel/qtestsupport_gui.cpp \
../painting/qdrawhelper_ssse3.cpp
manifestmeta.highlighted.names = "QtGui/Analog Clock Window Example"

0
src/widgets/doc/snippets/code/src_gui_kernel_qaction.cpp → src/gui/doc/snippets/code/src_gui_kernel_qaction.cpp
View File

0
src/widgets/doc/snippets/code/src_gui_kernel_qshortcut.cpp → src/gui/doc/snippets/code/src_gui_kernel_qshortcut.cpp
View File

0
src/widgets/doc/snippets/code/src_gui_util_qundostack.cpp → src/gui/doc/snippets/code/src_gui_util_qundostack.cpp
View File

4
src/gui/image/qimage.cpp
View File

@ -1476,7 +1476,7 @@ void QImage::setDevicePixelRatio(qreal scaleFactor)
\since 5.10
Returns the image data size in bytes.
\sa byteCount(), bytesPerLine(), bits(), {QImage#Image Information}{Image
\sa bytesPerLine(), bits(), {QImage#Image Information}{Image
Information}
*/
qsizetype QImage::sizeInBytes() const
@ -4278,7 +4278,7 @@ bool QImage::isDetached() const
The operation is similar to painting \a alphaChannel as an alpha image
over this image using \c QPainter::CompositionMode_DestinationIn.
\sa hasAlphaChannel(), alphaChannel(),
\sa hasAlphaChannel(),
{QImage#Image Transformations}{Image Transformations},
{QImage#Image Formats}{Image Formats}
*/

3
src/gui/image/qimage.h
View File

@ -298,7 +298,8 @@ public:
// Platform specific conversion functions
#if defined(Q_OS_DARWIN) || defined(Q_QDOC)
CGImageRef toCGImage() const Q_DECL_CF_RETURNS_RETAINED;
#elif defined(Q_OS_WIN) || defined(Q_QDOC)
#endif
#if defined(Q_OS_WIN) || defined(Q_QDOC)
HBITMAP toHBITMAP() const;
HICON toHICON(const QImage &mask = {}) const;
static QImage fromHBITMAP(HBITMAP hbitmap);

2
src/gui/image/qimageiohandler.cpp
View File

@ -170,8 +170,10 @@
the transformation metadata of an image. A handler that supports this option
should not apply the transformation itself.
\if !defined(qt6)
\value TransformedByDefault. A handler that reports support for this feature
will have image transformation metadata applied by default on read.
\endif
*/
/*! \enum QImageIOHandler::Transformation

6
src/gui/image/qpicture.cpp
View File

@ -257,9 +257,6 @@ void QPicture::setData(const char* data, uint size)
Loads a picture from the file specified by \a fileName and returns
true if successful; otherwise invalidates the picture and returns \c false.
Please note that the \a format parameter has been deprecated and
will have no effect.
\sa save()
*/
@ -292,9 +289,6 @@ bool QPicture::load(QIODevice *dev)
Saves a picture to the file specified by \a fileName and returns
true if successful; otherwise returns \c false.
Please note that the \a format parameter has been deprecated and
will have no effect.
\sa load()
*/

2
src/gui/image/qpixmap_win.cpp
View File

@ -493,7 +493,7 @@ Q_GUI_EXPORT QImage qt_imageFromWinHBITMAP(HBITMAP bitmap, int hbitmapFormat = 0
/*!
\since 6.0
Returns a QImage that is equivalent to the given \a bitmap.
Returns a QImage that is equivalent to the given \a hbitmap.
HBITMAP does not store information about the alpha channel.

2
src/gui/kernel/qaction.cpp
View File

@ -1108,7 +1108,7 @@ QVariant QAction::data() const
}
/*!
Sets the action's internal data to the given \a userData.
Sets the action's internal data to the given \a data.
\sa data()
*/

2
src/gui/kernel/qopenglcontext.cpp
View File

@ -347,7 +347,7 @@ void QOpenGLContextPrivate::_q_screenDestroyed(QObject *object)
}
/*!
\fn template<typename T> T *QOpenGLContext::platformInterface<T>()
\fn template <typename T> T *QOpenGLContext::platformInterface() const
Returns a platform interface of type T for the context.

2
src/gui/kernel/qplatformscreen.cpp
View File

@ -67,8 +67,6 @@ QPlatformScreen::~QPlatformScreen()
}
/*!
\fn QPixmap QPlatformScreen::grabWindow(WId window, int x, int y, int width, int height) const
This function is called when Qt needs to be able to grab the content of a window.
Returns the content of the window specified with the WId handle within the boundaries of

2
src/gui/kernel/qscreen.cpp
View File

@ -518,7 +518,7 @@ QRect QScreen::availableVirtualGeometry() const
based on how it is being held; in that case, this \c orientation property
will change.
\sa primaryOrientation(), QWindow::contentOrientation(), QOrientationSensor
\sa primaryOrientation(), QWindow::contentOrientation()
*/
Qt::ScreenOrientation QScreen::orientation() const
{

47
src/gui/kernel/qshortcut.cpp
View File

@ -220,10 +220,7 @@ QShortcut::QShortcut(const QKeySequence &key, QObject *parent,
/*!
\fn template<typename Functor>
QShortcut(const QKeySequence &key, QObject *parent,
Functor functor,
Qt::ShortcutContext shortcutContext = Qt::WindowShortcut);
\fn template<typename Functor> QShortcut::QShortcut(const QKeySequence &key, QObject *parent, Functor functor, Qt::ShortcutContext shortcutContext = Qt::WindowShortcut)
\since 5.15
\overload
@ -231,10 +228,7 @@ QShortcut::QShortcut(const QKeySequence &key, QObject *parent,
\l{QShortcut::activated()}{activated()} signal to the \a functor.
*/
/*!
\fn template<typename Functor>
QShortcut(const QKeySequence &key, QObject *parent,
const QObject *context, Functor functor,
Qt::ShortcutContext shortcutContext = Qt::WindowShortcut);
\fn template<typename Functor> QShortcut::QShortcut(const QKeySequence &key, QObject *parent, const QObject *context, Functor functor, Qt::ShortcutContext shortcutContext = Qt::WindowShortcut)
\since 5.15
\overload
@ -246,46 +240,38 @@ QShortcut::QShortcut(const QKeySequence &key, QObject *parent,
If the \a context object is destroyed, the \a functor will not be called.
*/
/*!
\fn template<typename Functor, typename FunctorAmbiguous>
QShortcut(const QKeySequence &key, QObject *parent,
const QObject *context1, Functor functor,
FunctorAmbiguous functorAmbiguous,
Qt::ShortcutContext shortcutContext = Qt::WindowShortcut);
\fn template<typename Functor, typename FunctorAmbiguous> QShortcut::QShortcut(const QKeySequence &key, QObject *parent, const QObject *context, Functor functor, FunctorAmbiguous functorAmbiguous, Qt::ShortcutContext shortcutContext = Qt::WindowShortcut)
\since 5.15
\overload
This is a QShortcut convenience constructor which connects the shortcut's
\l{QShortcut::activated()}{activated()} signal to the \a functor and
\l{QShortcut::activatedAmbiguously()}{activatedAmbiguously()}
signal to the \a FunctorAmbiguous.
signal to the \a functorAmbiguous.
The \a functor and \a FunctorAmbiguous can be a pointer to a member
The \a functor and \a functorAmbiguous can be a pointer to a member
function of the \a context object.
If the \a context object is destroyed, the \a functor and
\a FunctorAmbiguous will not be called.
\a functorAmbiguous will not be called.
*/
/*!
\fn template<typename Functor, typename FunctorAmbiguous>
QShortcut(const QKeySequence &key, QObject *parent,
const QObject *context1, Functor functor,
const QObject *context2, FunctorAmbiguous functorAmbiguous,
Qt::ShortcutContext shortcutContext = Qt::WindowShortcut);
\fn template<typename Functor, typename FunctorAmbiguous> QShortcut::QShortcut(const QKeySequence &key, QObject *parent, const QObject *context1, Functor functor, const QObject *context2, FunctorAmbiguous functorAmbiguous, Qt::ShortcutContext shortcutContext = Qt::WindowShortcut)
\since 5.15
\overload
This is a QShortcut convenience constructor which connects the shortcut's
\l{QShortcut::activated()}{activated()} signal to the \a functor and
\l{QShortcut::activatedAmbiguously()}{activatedAmbiguously()}
signal to the \a FunctorAmbiguous.
signal to the \a functorAmbiguous.
The \a functor can be a pointer to a member function of the
\a context1 object.
The \a FunctorAmbiguous can be a pointer to a member function of the
The \a functorAmbiguous can be a pointer to a member function of the
\a context2 object.
If the \a context1 object is destroyed, the \a functor will not be called.
If the \a context2 object is destroyed, the \a FunctorAmbiguous
If the \a context2 object is destroyed, the \a functorAmbiguous
will not be called.
*/
@ -412,8 +398,7 @@ bool QShortcut::autoRepeat() const
/*!
\property QShortcut::whatsThis
\brief the shortcut's "What's This?" help text
Sets the shortcut's "What's This?" help \a text.
The text will be shown when a widget application is in "What's
This?" mode and the user types the shortcut key() sequence.
@ -421,9 +406,9 @@ bool QShortcut::autoRepeat() const
To set "What's This?" help on a menu item (with or without a
shortcut key), set the help on the item's action.
By default, this property contains an empty string.
By default, the help text is an empty string.
This property has no effect in applications that don't use
This function has no effect in applications that don't use
widgets.
\sa QWhatsThis::inWhatsThisMode(), QAction::setWhatsThis()
@ -434,13 +419,17 @@ void QShortcut::setWhatsThis(const QString &text)
d->sc_whatsthis = text;
}
/*!
Returns the shortcut's "What's This?" help text.
\sa setWhatsThis()
*/
QString QShortcut::whatsThis() const
{
Q_D(const QShortcut);
return d->sc_whatsthis;
}
/*!
Returns the shortcut's ID.

6
src/gui/kernel/qwindow.h
View File

@ -107,7 +107,7 @@ class Q_GUI_EXPORT QWindow : public QObject, public QSurface
// Any new properties which you add here MUST be versioned and MUST be documented both as
// C++ properties in qwindow.cpp AND as QML properties in qquickwindow.cpp.
// http://qt-project.org/doc/qt-5.0/qtqml/qtqml-cppintegration-definetypes.html#type-revisions-and-versions
// https://doc.qt.io/qt/qtqml-cppintegration-definetypes.html#type-revisions-and-versions
Q_PROPERTY(QString title READ title WRITE setTitle NOTIFY windowTitleChanged)
Q_PROPERTY(Qt::WindowModality modality READ modality WRITE setModality NOTIFY modalityChanged)
@ -125,7 +125,11 @@ class Q_GUI_EXPORT QWindow : public QObject, public QSurface
Q_PROPERTY(Visibility visibility READ visibility WRITE setVisibility NOTIFY visibilityChanged REVISION(2, 1))
Q_PROPERTY(Qt::ScreenOrientation contentOrientation READ contentOrientation WRITE reportContentOrientationChange NOTIFY contentOrientationChanged)
Q_PROPERTY(qreal opacity READ opacity WRITE setOpacity NOTIFY opacityChanged REVISION(2, 1))
#ifdef Q_QDOC
Q_PROPERTY(QWindow* transientParent READ transientParent WRITE setTransientParent NOTIFY transientParentChanged)
#else
Q_PRIVATE_PROPERTY(QWindow::d_func(), QWindow* transientParent MEMBER transientParent WRITE setTransientParent NOTIFY transientParentChanged REVISION(2, 13))
#endif
public:
enum Visibility {

4
src/gui/math3d/qmatrix4x4.cpp
View File

@ -1627,8 +1627,6 @@ void QMatrix4x4::copyDataTo(float *values) const
third row and third column of the QMatrix4x4. This is suitable
for implementing orthographic projections where the z co-ordinate
should be dropped rather than projected.
\sa toAffine()
*/
QTransform QMatrix4x4::toTransform() const
{
@ -1651,8 +1649,6 @@ QTransform QMatrix4x4::toTransform() const
of the QMatrix4x4. This is suitable for implementing
orthographic projections where the z co-ordinate should
be dropped rather than projected.
\sa toAffine()
*/
QTransform QMatrix4x4::toTransform(float distanceToPlane) const
{

4
src/gui/painting/qcolor.cpp
View File

@ -843,11 +843,15 @@ QColor::QColor(Spec spec) noexcept
#if QT_VERSION < QT_VERSION_CHECK(6,0,0)
/*!
\if !defined(qt6)
\fn QColor::QColor(const QColor &color)
Constructs a color that is a copy of \a color.
\sa isValid()
\else
\nothing
\endif
*/
#endif

4
src/gui/painting/qpaintengine_raster.cpp
View File

@ -339,7 +339,7 @@ QRasterPaintEnginePrivate::QRasterPaintEnginePrivate() :
\sa QPaintEngine
*/
/*!
/*
\fn QPaintEngine::Type QRasterPaintEngine::type() const
\reimp
*/
@ -4909,7 +4909,7 @@ static void drawEllipse_midpoint_i(const QRect &rect, const QRect &clip,
}
}
/*!
/*
\fn void QRasterPaintEngine::drawPoints(const QPoint *points, int pointCount)
\overload
\reimp

10
src/gui/painting/qrangecollection.cpp
View File

@ -96,7 +96,7 @@ QRangeCollection::~QRangeCollection()
}
/*!
Inserts a single number into the collection.
Inserts a single number \a pageNumber into the collection.
*/
void QRangeCollection::addPage(int pageNumber)
{
@ -110,7 +110,7 @@ void QRangeCollection::addPage(int pageNumber)
}
/*!
Inserts a range into the collection.
Inserts a range specified with \a from and \a to into the collection.
*/
void QRangeCollection::addRange(int from, int to)
{
@ -146,12 +146,14 @@ void QRangeCollection::clear()
}
/*!
Constructs the range collection from a string representation.
Constructs the range collection from a string representation of \a ranges.
\code
QPrinter printer;
printer->rangeCollection()->parse("1-3,6-7");
\endcode
Returns \c true on success.
*/
bool QRangeCollection::parse(const QString &ranges)
{
@ -233,6 +235,8 @@ QString QRangeCollection::toString() const
}
/*!
\fn bool QRangeCollection::contains(const int pageNumber) const
Returns \c true if the collection contains an occurrence
or a bounding range of \a pageNumber; otherwise returns
\c false.

30
src/gui/platform/darwin/qmacmime.mm
View File

@ -108,7 +108,8 @@ const QStringList& qt_mac_enabledDraggedTypes()
//#define DEBUG_MIME_MAPS
/*!
\class QMacPasteboardMime
\class QMacInternalPasteboardMime
\internal
\brief The QMacPasteboardMime class converts between a MIME type and a
\l{http://developer.apple.com/macosx/uniformtypeidentifiers.html}{Uniform
Type Identifier (UTI)} format.
@ -151,11 +152,12 @@ const QStringList& qt_mac_enabledDraggedTypes()
compatibility reasons, and should now be understood as UTIs.
*/
/*! \enum QMacPasteboardMime::QMacPasteboardMimeType
/*
\enum QMacPasteboardMime::QMacPasteboardMimeType
\internal
*/
/*!
/*
Constructs a new conversion object of type \a t, adding it to the
globally accessed list of available convertors.
*/
@ -164,7 +166,7 @@ QMacInternalPasteboardMime::QMacInternalPasteboardMime(char t) : type(t)
qt_mac_addToGlobalMimeList(this);
}
/*!
/*
Destroys a conversion object, removing it from the global
list of available convertors.
*/
@ -173,7 +175,7 @@ QMacInternalPasteboardMime::~QMacInternalPasteboardMime()
qt_mac_removeFromGlobalMimeList(this);
}
/*!
/*
Returns the item count for the given \a mimeData
*/
int QMacInternalPasteboardMime::count(QMimeData *mimeData)
@ -918,7 +920,7 @@ void QMacInternalPasteboardMime::destroyMimeTypes()
delete mimes->takeFirst();
}
/*!
/*
Returns the most-recently created QMacPasteboardMime of type \a t that can convert
between the \a mime and \a flav formats. Returns 0 if no such convertor
exists.
@ -946,7 +948,7 @@ QMacInternalPasteboardMime::convertor(uchar t, const QString &mime, QString flav
}
return 0;
}
/*!
/*
Returns a MIME type of type \a t for \a flav, or 0 if none exists.
*/
QString QMacInternalPasteboardMime::flavorToMime(uchar t, QString flav)
@ -969,7 +971,7 @@ QString QMacInternalPasteboardMime::flavorToMime(uchar t, QString flav)
return QString();
}
/*!
/*
Returns a list of all currently defined QMacPasteboardMime objects of type \a t.
*/
QList<QMacInternalPasteboardMime*> QMacInternalPasteboardMime::all(uchar t)
@ -984,7 +986,7 @@ QList<QMacInternalPasteboardMime*> QMacInternalPasteboardMime::all(uchar t)
}
/*!
/*
\fn QString QMacPasteboardMime::convertorName()
Returns a name for the convertor.
@ -992,7 +994,7 @@ QList<QMacInternalPasteboardMime*> QMacInternalPasteboardMime::all(uchar t)
All subclasses must reimplement this pure virtual function.
*/
/*!
/*
\fn bool QMacPasteboardMime::canConvert(const QString &mime, QString flav)
Returns \c true if the convertor can convert (both ways) between
@ -1001,7 +1003,7 @@ QList<QMacInternalPasteboardMime*> QMacInternalPasteboardMime::all(uchar t)
All subclasses must reimplement this pure virtual function.
*/
/*!
/*
\fn QString QMacPasteboardMime::mimeFor(QString flav)
Returns the MIME UTI used for Mac flavor \a flav, or 0 if this
@ -1010,7 +1012,7 @@ QList<QMacInternalPasteboardMime*> QMacInternalPasteboardMime::all(uchar t)
All subclasses must reimplement this pure virtual function.
*/
/*!
/*
\fn QString QMacPasteboardMime::flavorFor(const QString &mime)
Returns the Mac UTI used for MIME type \a mime, or 0 if this
@ -1019,7 +1021,7 @@ QList<QMacInternalPasteboardMime*> QMacInternalPasteboardMime::all(uchar t)
All subclasses must reimplement this pure virtual function.
*/
/*!
/*
\fn QVariant QMacPasteboardMime::convertToMime(const QString &mime, QList<QByteArray> data, QString flav)
Returns \a data converted from Mac UTI \a flav to MIME type \a
@ -1031,7 +1033,7 @@ QList<QMacInternalPasteboardMime*> QMacInternalPasteboardMime::all(uchar t)
All subclasses must reimplement this pure virtual function.
*/
/*!
/*
\fn QList<QByteArray> QMacPasteboardMime::convertFromMime(const QString &mime, QVariant data, QString flav)
Returns \a data converted from MIME type \a mime

4
src/gui/rhi/qshader.cpp
View File

@ -520,6 +520,7 @@ bool operator==(const QShader &lhs, const QShader &rhs) noexcept
}
/*!
\internal
\fn bool operator!=(const QShader &lhs, const QShader &rhs)
Returns \c false if the values in the two QShader objects \a a and \a b
@ -555,6 +556,7 @@ bool operator==(const QShaderVersion &lhs, const QShaderVersion &rhs) noexcept
}
/*!
\internal
\fn bool operator!=(const QShaderVersion &lhs, const QShaderVersion &rhs)
Returns \c false if the values in the two QShaderVersion objects \a a
@ -575,6 +577,7 @@ bool operator==(const QShaderKey &lhs, const QShaderKey &rhs) noexcept
}
/*!
\internal
\fn bool operator!=(const QShaderKey &lhs, const QShaderKey &rhs)
Returns \c false if the values in the two QShaderKey objects \a a
@ -608,6 +611,7 @@ bool operator==(const QShaderCode &lhs, const QShaderCode &rhs) noexcept
}
/*!
\internal
\fn bool operator!=(const QShaderCode &lhs, const QShaderCode &rhs)
Returns \c false if the values in the two QShaderCode objects \a a

4
src/gui/text/qfont.cpp
View File

@ -611,7 +611,7 @@ QFontEngineData::~QFontEngineData()
*/
#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
/*!
/*
\obsolete
Constructs a font from \a font for use on the paint device \a pd.
*/
@ -1922,7 +1922,7 @@ void QFont::removeSubstitutions(const QString &familyName)
/*!
Returns a sorted list of substituted family names.
\sa insertSubstitution(), removeSubstitution(), substitute()
\sa insertSubstitution(), removeSubstitutions(), substitute()
*/
QStringList QFont::substitutions()
{

8
src/gui/text/qrawfont.cpp
View File

@ -579,7 +579,7 @@ bool QRawFont::glyphIndexesForChars(const QChar *chars, int numChars, quint32 *g
to make it appear as if the two glyphs are unspaced. How the advances are calculated is
controlled by \a layoutFlags.
\sa QTextLine::horizontalAdvance(), QFontMetricsF::width()
\sa QTextLine::horizontalAdvance(), QFontMetricsF::horizontalAdvance()
*/
/*!
@ -592,7 +592,7 @@ bool QRawFont::glyphIndexesForChars(const QChar *chars, int numChars, quint32 *g
to make it appear as if the two glyphs are unspaced. The advance of each glyph is calculated
separately.
\sa QTextLine::horizontalAdvance(), QFontMetricsF::width()
\sa QTextLine::horizontalAdvance(), QFontMetricsF::horizontalAdvance()
*/
/*!
@ -604,7 +604,7 @@ bool QRawFont::glyphIndexesForChars(const QChar *chars, int numChars, quint32 *g
array \a glyphIndexes while the results are returned through \a advances, both of them must
have \a numGlyphs elements. How the advances are calculated is controlled by \a layoutFlags.
\sa QTextLine::horizontalAdvance(), QFontMetricsF::width()
\sa QTextLine::horizontalAdvance(), QFontMetricsF::horizontalAdvance()
*/
bool QRawFont::advancesForGlyphIndexes(const quint32 *glyphIndexes, QPointF *advances, int numGlyphs, LayoutFlags layoutFlags) const
{
@ -640,7 +640,7 @@ bool QRawFont::advancesForGlyphIndexes(const quint32 *glyphIndexes, QPointF *adv
array \a glyphIndexes while the results are returned through \a advances, both of them must
have \a numGlyphs elements. The advance of each glyph is calculated separately
\sa QTextLine::horizontalAdvance(), QFontMetricsF::width()
\sa QTextLine::horizontalAdvance(), QFontMetricsF::horizontalAdvance()
*/
bool QRawFont::advancesForGlyphIndexes(const quint32 *glyphIndexes, QPointF *advances, int numGlyphs) const
{

2
src/gui/text/qstatictext.cpp
View File

@ -207,7 +207,7 @@ void QStaticText::detach()
making changes, you can use the prepare() function and pass in the \a matrix and \a font you
expect to use when drawing the text.
\sa QPainter::setFont(), QPainter::setMatrix()
\sa QPainter::setFont(), QPainter::setWorldTransform()
*/
void QStaticText::prepare(const QTransform &matrix, const QFont &font)
{

9
src/gui/text/qtextdocumentfragment.cpp
View File

@ -1257,15 +1257,6 @@ void QTextHtmlImporter::appendBlock(const QTextBlockFormat &format, QTextCharFor
#endif // QT_NO_TEXTHTMLPARSER
/*!
\fn QTextDocumentFragment QTextDocumentFragment::fromHtml(const QString &text)
Returns a QTextDocumentFragment based on the arbitrary piece of
HTML in the given \a text. The formatting is preserved as much as
possible; for example, "<b>bold</b>" will become a document
fragment with the text "bold" with a bold character format.
*/
#ifndef QT_NO_TEXTHTMLPARSER
/*!
\fn QTextDocumentFragment QTextDocumentFragment::fromHtml(const QString &text, const QTextDocument *resourceProvider)

4
src/gui/text/qtextlayout.cpp
View File

@ -356,9 +356,13 @@ QTextLayout::QTextLayout(const QString& text)
#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
/*!
\if !defined(qt6)
\fn QTextLayout::QTextLayout(const QString &text, const QFont &font, QPaintDevice *paintdevice)
\obsolete
Identical to QTextLayout::QTextLayout(const QString &text, const QFont &font, const QPaintDevice *paintdevice)
\else
\nothing
\endif
*/
QTextLayout::QTextLayout(const QString &text, const QFont &font, QPaintDevice *paintdevice)

6
src/gui/text/qtextobject.cpp
View File

@ -928,12 +928,6 @@ bool QTextBlock::isValid() const
Constructs an iterator for this text block.
*/
/*!
\fn QTextBlock::iterator::iterator(const iterator &other)
Copy constructor. Constructs a copy of the \a other iterator.
*/
/*!
\fn bool QTextBlock::iterator::atEnd() const

4
src/gui/text/qtextoption.cpp
View File

@ -156,7 +156,7 @@ void QTextOption::setTabArray(const QList<qreal> &tabStops)
Sets the tab positions for the text layout to those specified by
\a tabStops.
\sa tabStop()
\sa tabStopDistance()
*/
void QTextOption::setTabs(const QList<QTextOption::Tab> &tabStops)
{
@ -168,7 +168,7 @@ void QTextOption::setTabs(const QList<QTextOption::Tab> &tabStops)
/*!
Returns a list of tab positions defined for the text layout.
\sa setTabArray(), tabStop()
\sa setTabArray(), tabStopDistance()
*/
QList<qreal> QTextOption::tabArray() const
{

2
src/gui/text/windows/qwindowsfontdatabase.cpp
View File

@ -95,7 +95,7 @@ static inline bool useDirectWrite(QFont::HintingPreference hintingPreference,
#endif // !QT_NO_DIRECTWRITE
/*!
\struct QWindowsFontEngineData
\class QWindowsFontEngineData
\brief Static constant data shared by the font engines.
\internal
*/

4
src/gui/text/windows/qwindowsfontdatabase_ft.cpp
View File

@ -330,8 +330,8 @@ static int QT_WIN_CALLBACK storeFont(const LOGFONT *logFont, const TEXTMETRIC *t
return 1;
}
/*!
\brief Populate font database using EnumFontFamiliesEx().
/*
\brief Populates the font database using EnumFontFamiliesEx().
Normally, leaving the name empty should enumerate
all fonts, however, system fonts like "MS Shell Dlg 2"

14
src/gui/vulkan/qvulkanwindow.cpp
View File

@ -1579,8 +1579,8 @@ bool QVulkanWindow::event(QEvent *e)
/*!
\typedef QVulkanWindow::QueueCreateInfoModifier
A function function that is called during graphics initialization to add
additAional queues that should be created.
A function that is called during graphics initialization to add
additional queues that should be created.
Set if the renderer needs additional queues besides the default graphics
queue (e.g. a transfer queue).
@ -1588,17 +1588,17 @@ bool QVulkanWindow::event(QEvent *e)
the additional queues.
The renderer can subsequently request the actual queue in initResources().
Note when requesting additional graphics queues: Qt itself always requests
a graphics queue, you'll need to search queueCreateInfo for the appropriate
\note When requesting additional graphics queues, Qt itself always requests
a graphics queue. You'll need to search queueCreateInfo for the appropriate
entry and manipulate it to obtain the additional queue.
\sa setQueueCreateInfoModifier()
*/
/*!
Set a queue create info modification function.
Sets the queue create info modification function \a modifier.
\sa queueCreateInfoModifier()
\sa QueueCreateInfoModifier
\since 5.15
*/
@ -1746,7 +1746,7 @@ void QVulkanWindowRenderer::releaseResources()
}
/*!
\fn QVulkanWindowRenderer::startNextFrame()
\fn void QVulkanWindowRenderer::startNextFrame()
This virtual function is called when the draw calls for the next frame are
to be added to the command buffer.