1berry/qtbase
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Doc: Add missing brief statements for \property documentation

Browse Source 
... where applicable.

Fixes: QTBUG-88232
Change-Id: I835df434765caededd35d5114965b4a1663e7942
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
This commit is contained in:
Topi Reinio 2020-11-11 19:15:28 +01:00
parent 328cad011e
commit d01b9ac6af
13 changed files with 52 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/corelib/animation/qsequentialanimationgroup.cpp
View File

@ -293,7 +293,7 @@ QPauseAnimation *QSequentialAnimationGroup::insertPause(int index, int msecs)
/*!
\property QSequentialAnimationGroup::currentAnimation
Returns the animation in the current time.
\brief the animation in the current time.
*/
QAbstractAnimation *QSequentialAnimationGroup::currentAnimation() const
{

2
src/corelib/kernel/qcoreevent.cpp
View File

@ -380,7 +380,7 @@ QEvent::~QEvent()
/*!
\property QEvent::accepted
the accept flag of the event object
\brief the accept flag of the event object.
Setting the accept parameter indicates that the event receiver
wants the event. Unwanted events might be propagated to the parent

4
src/corelib/serialization/qxmlstream.cpp
View File

@ -741,7 +741,7 @@ static const short QXmlStreamReader_tokenTypeString_indices[] = {
/*!
\property QXmlStreamReader::namespaceProcessing
The namespace-processing flag of the stream reader
\brief the namespace-processing flag of the stream reader.
This property controls whether or not the stream reader processes
namespaces. If enabled, the reader processes namespaces, otherwise
@ -3165,7 +3165,7 @@ QIODevice *QXmlStreamWriter::device() const
/*!
\property QXmlStreamWriter::autoFormatting
\since 4.4
The auto-formatting flag of the stream writer
\brief the auto-formatting flag of the stream writer.
This property controls whether or not the stream writer
automatically formats the generated XML data. If enabled, the

12
src/corelib/thread/qthreadpool.cpp
View File

@ -582,8 +582,9 @@ bool QThreadPool::tryStart(std::function<void()> functionToRun)
}
/*! \property QThreadPool::expiryTimeout
\brief the thread expiry timeout value in milliseconds.
Threads that are unused for \a expiryTimeout milliseconds are considered
Threads that are unused for \e expiryTimeout milliseconds are considered
to have expired and will exit. Such threads will be restarted as needed.
The default \a expiryTimeout is 30000 milliseconds (30 seconds). If
\a expiryTimeout is negative, newly created threads will not expire, e.g.,
@ -611,8 +612,7 @@ void QThreadPool::setExpiryTimeout(int expiryTimeout)
/*! \property QThreadPool::maxThreadCount
This property represents the maximum number of threads used by the thread
pool.
\brief the maximum number of threads used by the thread pool.
\note The thread pool will always use at least 1 thread, even if
\a maxThreadCount limit is zero or negative.
@ -640,7 +640,7 @@ void QThreadPool::setMaxThreadCount(int maxThreadCount)
/*! \property QThreadPool::activeThreadCount
This property represents the number of active threads in the thread pool.
\brief the number of active threads in the thread pool.
\note It is possible for this function to return a value that is greater
than maxThreadCount(). See reserveThread() for more details.
@ -675,9 +675,7 @@ void QThreadPool::reserveThread()
}
/*! \property QThreadPool::stackSize
This property contains the stack size for the thread pool worker
threads.
\brief the stack size for the thread pool worker threads.
The value of the property is only used when the thread pool creates
new threads. Changing it has no effect for already created

9
src/dbus/qdbusservicewatcher.cpp
View File

@ -170,18 +170,17 @@ void QDBusServiceWatcherPrivate::removeService(const QString &service)
/*!
\property QDBusServiceWatcher::watchMode
\brief the current watch mode for this QDBusServiceWatcher object.
The \c watchMode property holds the current watch mode for this
QDBusServiceWatcher object. The default value for this property is
The default value for this property is
QDBusServiceWatcher::WatchForOwnershipChange.
*/
/*!
\property QDBusServiceWatcher::watchedServices
\brief the list of services watched.
The \c servicesWatched property holds the list of services watched.
Note that modifying this list with setServicesWatched() is an expensive
\note Modifying this list with setServicesWatched() is an expensive
operation. If you can, prefer to change it by way of addWatchedService()
and removeWatchedService().
*/

50
src/gui/kernel/qeventpoint.cpp
View File

@ -166,7 +166,7 @@ QEventPoint::~QEventPoint()
/*!
\property QEventPoint::position
the position of this point
\brief the position of this point.
The position is relative to the widget or item that received the event.
*/
@ -175,7 +175,7 @@ QPointF QEventPoint::position() const
/*!
\property QEventPoint::pressPosition
the position at which this point was pressed
\brief the position at which this point was pressed.
The position is relative to the widget or item that received the event.
@ -186,7 +186,7 @@ QPointF QEventPoint::pressPosition() const
/*!
\property QEventPoint::grabPosition
the position at which this point was grabbed
\brief the position at which this point was grabbed.
The position is relative to the widget or item that received the event.
@ -197,7 +197,7 @@ QPointF QEventPoint::grabPosition() const
/*!
\property QEventPoint::lastPosition
the position of this point from the previous press or move event
\brief the position of this point from the previous press or move event.
The position is relative to the widget or item that received the event.
@ -208,7 +208,7 @@ QPointF QEventPoint::lastPosition() const
/*!
\property QEventPoint::scenePosition
the scene position of this point
\brief the scene position of this point.
The scene position is the position relative to QQuickWindow if handled in QQuickItem::event(),
in QGraphicsScene coordinates if handled by an override of QGraphicsItem::touchEvent(),
@ -221,7 +221,7 @@ QPointF QEventPoint::scenePosition() const
/*!
\property QEventPoint::scenePressPosition
the scene position at which this point was pressed
\brief the scene position at which this point was pressed.
The scene position is the position relative to QQuickWindow if handled in QQuickItem::event(),
in QGraphicsScene coordinates if handled by an override of QGraphicsItem::touchEvent(),
@ -234,7 +234,7 @@ QPointF QEventPoint::scenePressPosition() const
/*!
\property QEventPoint::sceneGrabPosition
the scene position at which this point was grabbed
\brief the scene position at which this point was grabbed.
The scene position is the position relative to QQuickWindow if handled in QQuickItem::event(),
in QGraphicsScene coordinates if handled by an override of QGraphicsItem::touchEvent(),
@ -247,7 +247,7 @@ QPointF QEventPoint::sceneGrabPosition() const
/*!
\property QEventPoint::sceneLastPosition
the scene position of this point from the previous press or move event
\brief the scene position of this point from the previous press or move event.
The scene position is the position relative to QQuickWindow if handled in QQuickItem::event(),
in QGraphicsScene coordinates if handled by an override of QGraphicsItem::touchEvent(),
@ -260,7 +260,7 @@ QPointF QEventPoint::sceneLastPosition() const
/*!
\property QEventPoint::globalPosition
the global position of this point
\brief the global position of this point.
The global position is relative to the screen or virtual desktop.
@ -271,7 +271,7 @@ QPointF QEventPoint::globalPosition() const
/*!
\property QEventPoint::globalPressPosition
the global position at which this point was pressed
\brief the global position at which this point was pressed.
The global position is relative to the screen or virtual desktop.
@ -282,7 +282,7 @@ QPointF QEventPoint::globalPressPosition() const
/*!
\property QEventPoint::globalGrabPosition
the global position at which this point was grabbed
\brief the global position at which this point was grabbed.
The global position is relative to the screen or virtual desktop.
@ -293,7 +293,7 @@ QPointF QEventPoint::globalGrabPosition() const
/*!
\property QEventPoint::globalLastPosition
the global position of this point from the previous press or move event
\brief the global position of this point from the previous press or move event.
The global position is relative to the screen or virtual desktop.
@ -304,7 +304,7 @@ QPointF QEventPoint::globalLastPosition() const
/*!
\property QEventPoint::velocity
a velocity vector, in units of pixels per second, in the coordinate
\brief a velocity vector, in units of pixels per second, in the coordinate.
system of the screen or desktop.
\note If the device's capabilities include QInputDevice::Velocity, it means
@ -323,21 +323,21 @@ QVector2D QEventPoint::velocity() const
/*!
\property QEventPoint::state
the current state of the event point.
\brief the current state of the event point.
*/
QEventPoint::State QEventPoint::state() const
{ return d->state; }
/*!
\property QEventPoint::device
the pointing device from which this event point originates
\brief the pointing device from which this event point originates.
*/
const QPointingDevice *QEventPoint::device() const
{ return d->device; }
/*!
\property QEventPoint::id
the ID number of this event point
\brief the ID number of this event point.
\note Do not assume that ID numbers start at zero or that they are
sequential. Such an assumption is often false due to the way
@ -348,7 +348,7 @@ int QEventPoint::id() const
/*!
\property QEventPoint::uniqueId
the unique ID of this point or token, if any
\brief the unique ID of this point or token, if any.
It is often invalid (see \l {QPointingDeviceUniqueId::isValid()} {isValid()}),
because touchscreens cannot uniquely identify fingers.
@ -364,7 +364,7 @@ QPointingDeviceUniqueId QEventPoint::uniqueId() const
/*!
\property QEventPoint::timestamp
the most recent time at which this point was included in a QPointerEvent
\brief the most recent time at which this point was included in a QPointerEvent.
\sa QPointerEvent::timestamp()
*/
@ -373,7 +373,7 @@ ulong QEventPoint::timestamp() const
/*!
\property QEventPoint::lastTimestamp
the time from the previous QPointerEvent that contained this point
\brief the time from the previous QPointerEvent that contained this point.
\sa globalLastPosition
*/
@ -382,7 +382,7 @@ ulong QEventPoint::lastTimestamp() const
/*!
\property QEventPoint::pressTimestamp
the most recent time at which this point was pressed
\brief the most recent time at which this point was pressed.
\sa timestamp
*/
@ -391,7 +391,7 @@ ulong QEventPoint::pressTimestamp() const
/*!
\property QEventPoint::timeHeld
the duration, in milliseconds, since this point was pressed and not released
\brief the duration, in milliseconds, since this point was pressed and not released.
\sa pressTimestamp, timestamp
*/
@ -400,7 +400,7 @@ qreal QEventPoint::timeHeld() const
/*!
\property QEventPoint::pressure
the pressure of this point
\brief the pressure of this point.
The return value is in the range \c 0.0 to \c 1.0.
*/
@ -409,7 +409,7 @@ qreal QEventPoint::pressure() const
/*!
\property QEventPoint::rotation
the angular orientation of this point
\brief the angular orientation of this point.
The return value is in degrees, where zero (the default) indicates the finger,
token or stylus is pointing upwards, a negative angle means it's rotated to the
@ -421,7 +421,7 @@ qreal QEventPoint::rotation() const
/*!
\property QEventPoint::ellipseDiameters
the width and height of the bounding ellipse of the touch point
\brief the width and height of the bounding ellipse of the touch point.
The return value is in logical pixels. Most touchscreens do not detect the
shape of the contact point, and no mice or tablet devices can detect it,
@ -433,7 +433,7 @@ QSizeF QEventPoint::ellipseDiameters() const
/*!
\property QEventPoint::accepted
the accepted state of the event point
\brief the accepted state of the event point.
In widget-based applications, this property is not used, as it's only meaningful
for a widget to accept or reject a complete QInputEvent.

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

@ -833,7 +833,7 @@ void QTextDocument::adjustSize()
\property QTextDocument::size
\since 4.2
Returns the actual size of the document.
\brief the actual size of the document.
This is equivalent to documentLayout()->documentSize();
The size of the document can be changed either by setting
@ -855,7 +855,7 @@ QSizeF QTextDocument::size() const
\property QTextDocument::blockCount
\since 4.2
Returns the number of text blocks in the document.
\brief the number of text blocks in the document.
The value of this property is undefined in documents with tables or frames.

5
src/network/socket/qlocalserver.cpp
View File

@ -138,8 +138,9 @@ QLocalServer::~QLocalServer()
\property QLocalServer::socketOptions
\since 5.0
The setSocketOptions method controls how the socket operates.
For example the socket may restrict access to what user ids can
\brief the socket options that control how the socket operates.
For example, the socket may restrict access to what user ids can
connect to the socket.
These options must be set before listen() is called.

4
src/widgets/graphicsview/qgraphicsitem.cpp
View File

@ -7911,7 +7911,7 @@ void QGraphicsItemPrivate::resetHeight()
/*!
\property QGraphicsObject::rotation
This property holds the rotation of the item in degrees.
\brief the rotation of the item in degrees.
This specifies how many degrees to rotate the item around its transformOrigin.
The default rotation is 0 degrees (i.e. not rotated at all).
@ -7925,7 +7925,7 @@ void QGraphicsItemPrivate::resetHeight()
/*!
\property QGraphicsObject::scale
This property holds the scale of the item.
\brief the scale of the item.
A scale of less than 1 means the item will be displayed smaller than
normal, and a scale of greater than 1 means the item will be

1
src/widgets/kernel/qapplication.cpp
View File

@ -2545,6 +2545,7 @@ void QApplication::setStartDragDistance(int l)
/*!
\property QApplication::startDragDistance
\brief the minimum distance required for a drag and drop operation to start.
If you support drag and drop in your application, and want to start a drag
and drop operation after the user has moved the cursor a certain distance

2
src/widgets/widgets/qabstractscrollarea.cpp
View File

@ -1482,7 +1482,7 @@ QSize QAbstractScrollArea::viewportSizeHint() const
/*!
\since 5.2
\property QAbstractScrollArea::sizeAdjustPolicy
This property holds the policy describing how the size of the scroll area changes when the
\brief the policy describing how the size of the scroll area changes when the
size of the viewport changes.
The default policy is QAbstractScrollArea::AdjustIgnored.

2
src/widgets/widgets/qabstractspinbox.cpp
View File

@ -420,7 +420,7 @@ bool QAbstractSpinBox::isAccelerated() const
\since 5.3
This property holds whether a thousands separator is enabled. By default this
\brief whether a thousands separator is enabled. By default this
property is false.
*/
bool QAbstractSpinBox::isGroupSeparatorShown() const

7
src/widgets/widgets/qtextedit.cpp
View File

@ -580,8 +580,9 @@ void QTextEditPrivate::_q_ensureVisible(const QRectF &_rect)
\property QTextEdit::plainText
\since 4.3
This property gets and sets the text editor's contents as plain
text. Previous contents are removed and undo/redo history is reset
\brief the text editor's contents as plain text.
Previous contents are removed and undo/redo history is reset
when the property is set. currentCharFormat() is also reset, unless
textCursor() is already at the beginning of the document.
@ -598,7 +599,7 @@ void QTextEditPrivate::_q_ensureVisible(const QRectF &_rect)
/*!
\property QTextEdit::undoRedoEnabled
\brief whether undo and redo are enabled
\brief whether undo and redo are enabled.
Users are only able to undo or redo actions if this property is
true, and if there is an action that can be undone (or redone).