diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2021-02-26 14:21:48 +0100 |
|---|---|---|
| committer | Topi Reinio <topi.reinio@qt.io> | 2021-03-16 13:17:39 +0100 |
| commit | 00e10f62b55626097e94a2d70a9214c0062fbcd5 (patch) | |
| tree | ada08b076d28280ef8c008e7495c4cebbbb989d0 /src/gui | |
| parent | 0bd705d91bc7a883a90abf3a6a6f638301fe2f75 (diff) | |
Doc: Fix various documentation issues
- Document QIODeviceBase
- Document QPointerEvent::points
- Fix linking issues
Task-number: QTBUG-90662
Change-Id: Ib123d5708953b22e01f95c82626b39a49fff95b2
Reviewed-by: Nico Vertriest <nico.vertriest@qt.io>
Diffstat (limited to 'src/gui')
| -rw-r--r-- | src/gui/image/qimagereader.cpp | 4 | ||||
| -rw-r--r-- | src/gui/kernel/qevent.cpp | 6 | ||||
| -rw-r--r-- | src/gui/text/qtextdocumentwriter.cpp | 5 |
3 files changed, 11 insertions, 4 deletions
diff --git a/src/gui/image/qimagereader.cpp b/src/gui/image/qimagereader.cpp index 611cbb1df1..fccf67b428 100644 --- a/src/gui/image/qimagereader.cpp +++ b/src/gui/image/qimagereader.cpp @@ -769,7 +769,7 @@ bool QImageReader::decideFormatFromContent() const otherwise left unchanged. If the device is not already open, QImageReader will attempt to - open the device in \l QIODevice::ReadOnly mode by calling + open the device in \l {QIODeviceBase::}{ReadOnly} mode by calling open(). Note that this does not work for certain devices, such as QProcess, QTcpSocket and QUdpSocket, where more logic is required to open the device. @@ -799,7 +799,7 @@ QIODevice *QImageReader::device() const /*! Sets the file name of QImageReader to \a fileName. Internally, QImageReader will create a QFile object and open it in \l - QIODevice::ReadOnly mode, and use this when reading images. + {QIODeviceBase::}{ReadOnly} mode, and use this when reading images. If \a fileName does not include a file extension (e.g., .png or .bmp), QImageReader will cycle through all supported extensions until it finds diff --git a/src/gui/kernel/qevent.cpp b/src/gui/kernel/qevent.cpp index edf00928eb..adc1029754 100644 --- a/src/gui/kernel/qevent.cpp +++ b/src/gui/kernel/qevent.cpp @@ -253,6 +253,12 @@ QInputEvent::~QInputEvent() */ /*! + \fn const QList<QEventPoint> &QPointerEvent::points() const + + Returns a list of points in this pointer event. +*/ + +/*! \fn QPointingDevice::PointerType QPointerEvent::pointerType() const Returns the type of point that generated the event. diff --git a/src/gui/text/qtextdocumentwriter.cpp b/src/gui/text/qtextdocumentwriter.cpp index db2129d809..b81c9d958b 100644 --- a/src/gui/text/qtextdocumentwriter.cpp +++ b/src/gui/text/qtextdocumentwriter.cpp @@ -182,7 +182,7 @@ QByteArray QTextDocumentWriter::format () const unchanged. If the device is not already open, QTextDocumentWriter will attempt to - open the device in \l QIODevice::WriteOnly mode by calling open(). + open the device in \l {QIODeviceBase::}{WriteOnly} mode by calling open(). \note This will not work for certain devices, such as QProcess, QTcpSocket and QUdpSocket, where some configuration is required before @@ -211,7 +211,8 @@ QIODevice *QTextDocumentWriter::device () const /*! Sets the name of the file to be written to \a fileName. Internally, QTextDocumentWriter will create a QFile and open it in \l - QIODevice::WriteOnly mode, and use this file when writing the document. + {QIODeviceBase::}{WriteOnly} mode, and use this file when writing the + document. \sa fileName(), setDevice() */ |