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

doc: Add missing return types to \fn commands

Browse Source 
Added void return type to several \fn commands.
The return type should always be included with
the \fn command in clang-qdoc.

Change-Id: Ie751eb1430eff668f33f8d86e0b1454bd1d2f582
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
This commit is contained in:
Martin Smith 2018-01-16 13:47:35 +01:00
parent e65caf92af
commit 20be99dec5
5 changed files with 29 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -4256,7 +4256,7 @@ void QPainter::drawEllipse(const QRectF &r)
}
/*!
\fn QPainter::drawEllipse(const QRect &rectangle)
\fn void QPainter::drawEllipse(const QRect &rectangle)
\overload
@ -4298,7 +4298,7 @@ void QPainter::drawEllipse(const QRect &r)
}
/*!
\fn QPainter::drawEllipse(int x, int y, int width, int height)
\fn void QPainter::drawEllipse(int x, int y, int width, int height)
\overload
@ -4309,7 +4309,7 @@ void QPainter::drawEllipse(const QRect &r)
/*!
\since 4.4
\fn QPainter::drawEllipse(const QPointF &center, qreal rx, qreal ry)
\fn void QPainter::drawEllipse(const QPointF &center, qreal rx, qreal ry)
\overload
@ -4319,7 +4319,7 @@ void QPainter::drawEllipse(const QRect &r)
/*!
\since 4.4
\fn QPainter::drawEllipse(const QPoint &center, int rx, int ry)
\fn void QPainter::drawEllipse(const QPoint &center, int rx, int ry)
\overload
@ -6737,7 +6737,7 @@ void QPainter::drawTiledPixmap(const QRectF &r, const QPixmap &pixmap, const QPo
}
/*!
\fn QPainter::drawTiledPixmap(const QRect &rectangle, const QPixmap &pixmap,
\fn void QPainter::drawTiledPixmap(const QRect &rectangle, const QPixmap &pixmap,
const QPoint &position = QPoint())
\overload

2
src/gui/painting/qregion.cpp
View File

@ -742,7 +742,7 @@ bool QRegion::intersects(const QRegion &region) const
#if !defined (Q_OS_UNIX) && !defined (Q_OS_WIN) || defined(Q_CLANG_QDOC)
/*!
/*
\overload
\since 4.4
*/

8
src/gui/painting/qrgba64.qdoc
View File

@ -105,7 +105,7 @@
*/
/*!
\fn QRgba64::setRed(quint16 red)
\fn void QRgba64::setRed(quint16 red)
Sets the red color component of this color to \a red.
@ -121,7 +121,7 @@
*/
/*!
\fn QRgba64::setGreen(quint16 green)
\fn void QRgba64::setGreen(quint16 green)
Sets the green color component of this color to \a green.
@ -137,7 +137,7 @@
*/
/*!
\fn QRgba64::setBlue(quint16 blue)
\fn void QRgba64::setBlue(quint16 blue)
Sets the blue color component of this color to \a blue.
@ -153,7 +153,7 @@
*/
/*!
\fn QRgba64::setAlpha(quint16 alpha)
\fn void QRgba64::setAlpha(quint16 alpha)
Sets the alpha of this color to \a alpha.

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

@ -974,7 +974,7 @@ QString QTextDocument::defaultStyleSheet() const
/*!
\fn QTextDocument::undoAvailable(bool available);
\fn void QTextDocument::undoAvailable(bool available);
This signal is emitted whenever undo operations become available
(\a available is true) or unavailable (\a available is false).
@ -986,14 +986,14 @@ QString QTextDocument::defaultStyleSheet() const
*/
/*!
\fn QTextDocument::redoAvailable(bool available);
\fn void QTextDocument::redoAvailable(bool available);
This signal is emitted whenever redo operations become available
(\a available is true) or unavailable (\a available is false).
*/
/*!
\fn QTextDocument::cursorPositionChanged(const QTextCursor &cursor);
\fn void QTextDocument::cursorPositionChanged(const QTextCursor &cursor);
This signal is emitted whenever the position of a cursor changed
due to an editing operation. The cursor that changed is passed in
@ -1003,7 +1003,7 @@ QString QTextDocument::defaultStyleSheet() const
*/
/*!
\fn QTextDocument::blockCountChanged(int newBlockCount);
\fn void QTextDocument::blockCountChanged(int newBlockCount);
\since 4.3
This signal is emitted when the total number of text blocks in the
@ -1012,7 +1012,7 @@ QString QTextDocument::defaultStyleSheet() const
*/
/*!
\fn QTextDocument::documentLayoutChanged();
\fn void QTextDocument::documentLayoutChanged();
\since 4.4
This signal is emitted when a new document layout is set.
@ -1845,7 +1845,7 @@ QFont QTextDocument::defaultFont() const
}
/*!
\fn QTextDocument::modificationChanged(bool changed)
\fn void QTextDocument::modificationChanged(bool changed)
This signal is emitted whenever the content of the document
changes in a way that affects the modification state. If \a

26
src/gui/text/qtextformat.cpp
View File

@ -2588,13 +2588,13 @@ QTextFrameFormat::QTextFrameFormat(const QTextFormat &fmt)
}
/*!
\fn QTextFrameFormat::isValid() const
\fn bool QTextFrameFormat::isValid() const
Returns \c true if the format description is valid; otherwise returns \c false.
*/
/*!
\fn QTextFrameFormat::setPosition(Position policy)
\fn void QTextFrameFormat::setPosition(Position policy)
Sets the \a policy for positioning frames with this frame format.
@ -2607,7 +2607,7 @@ QTextFrameFormat::QTextFrameFormat(const QTextFormat &fmt)
*/
/*!
\fn QTextFrameFormat::setBorder(qreal width)
\fn void QTextFrameFormat::setBorder(qreal width)
Sets the \a width (in pixels) of the frame's border.
*/
@ -2619,7 +2619,7 @@ QTextFrameFormat::QTextFrameFormat(const QTextFormat &fmt)
*/
/*!
\fn QTextFrameFormat::setBorderBrush(const QBrush &brush)
\fn void QTextFrameFormat::setBorderBrush(const QBrush &brush)
\since 4.3
Sets the \a brush used for the frame's border.
@ -2633,7 +2633,7 @@ QTextFrameFormat::QTextFrameFormat(const QTextFormat &fmt)
*/
/*!
\fn QTextFrameFormat::setBorderStyle(BorderStyle style)
\fn void QTextFrameFormat::setBorderStyle(BorderStyle style)
\since 4.3
Sets the \a style of the frame's border.
@ -2647,7 +2647,7 @@ QTextFrameFormat::QTextFrameFormat(const QTextFormat &fmt)
*/
/*!
\fn QTextFrameFormat::setMargin(qreal margin)
\fn void QTextFrameFormat::setMargin(qreal margin)
Sets the frame's \a margin in pixels.
This method also sets the left, right, top and bottom margins
@ -2671,7 +2671,7 @@ void QTextFrameFormat::setMargin(qreal amargin)
*/
/*!
\fn QTextFrameFormat::setTopMargin(qreal margin)
\fn void QTextFrameFormat::setTopMargin(qreal margin)
\since 4.3
Sets the frame's top \a margin in pixels.
@ -2691,7 +2691,7 @@ qreal QTextFrameFormat::topMargin() const
}
/*!
\fn QTextFrameFormat::setBottomMargin(qreal margin)
\fn void QTextFrameFormat::setBottomMargin(qreal margin)
\since 4.3
Sets the frame's bottom \a margin in pixels.
@ -2711,7 +2711,7 @@ qreal QTextFrameFormat::bottomMargin() const
}
/*!
\fn QTextFrameFormat::setLeftMargin(qreal margin)
\fn void QTextFrameFormat::setLeftMargin(qreal margin)
\since 4.3
Sets the frame's left \a margin in pixels.
@ -2731,7 +2731,7 @@ qreal QTextFrameFormat::leftMargin() const
}
/*!
\fn QTextFrameFormat::setRightMargin(qreal margin)
\fn void QTextFrameFormat::setRightMargin(qreal margin)
\since 4.3
Sets the frame's right \a margin in pixels.
@ -2751,7 +2751,7 @@ qreal QTextFrameFormat::rightMargin() const
}
/*!
\fn QTextFrameFormat::setPadding(qreal width)
\fn void QTextFrameFormat::setPadding(qreal width)
Sets the \a width of the frame's internal padding in pixels.
*/
@ -2763,7 +2763,7 @@ qreal QTextFrameFormat::rightMargin() const
*/
/*!
\fn QTextFrameFormat::setWidth(const QTextLength &width)
\fn void QTextFrameFormat::setWidth(const QTextLength &width)
Sets the frame's border rectangle's \a width.
@ -2771,7 +2771,7 @@ qreal QTextFrameFormat::rightMargin() const
*/
/*!
\fn QTextFrameFormat::setWidth(qreal width)
\fn void QTextFrameFormat::setWidth(qreal width)
\overload
Convenience method that sets the width of the frame's border