diff options
author | Martin Smith <[email protected]> | 2017-01-04 12:54:40 +0100 |
---|---|---|
committer | Martin Smith <[email protected]> | 2017-01-06 07:04:12 +0000 |
commit | 45ff1cf60a645abca054d4375398281e1240b151 (patch) | |
tree | 59e0dba41cb22fe7903aec73542d5c0a39aad5ce | |
parent | ed6b6bc03945cca0a20615834f7910e4183bac1c (diff) |
doc: Fix all remaining "Cannot tie" errors in QtBase
Most of these involved moving or removing extraneous
aide-memoir comments left by programmers between qdoc
comments and their functions. There were also some
cases where Q_CLANG_QDOC had to be tested to make
something visible to clangqdoc. And there were a few
functions that should not have been documented at all.
Change-Id: I3bf7c397a9e5ddbffc40cc1fee7f19cad71a1ae7
Reviewed-by: Topi Reiniƶ <[email protected]>
-rw-r--r-- | qmake/library/proitems.cpp | 2 | ||||
-rw-r--r-- | src/corelib/tools/qvsnprintf.cpp | 2 | ||||
-rw-r--r-- | src/gui/kernel/qevent.cpp | 3 | ||||
-rw-r--r-- | src/gui/kernel/qplatformwindow.cpp | 4 | ||||
-rw-r--r-- | src/gui/painting/qregion.cpp | 2 | ||||
-rw-r--r-- | src/network/socket/qabstractsocket.cpp | 1 | ||||
-rw-r--r-- | src/network/ssl/qsslerror.cpp | 4 | ||||
-rw-r--r-- | src/network/ssl/qsslsocket.cpp | 1 | ||||
-rw-r--r-- | src/sql/models/qsqlrelationaltablemodel.cpp | 3 | ||||
-rw-r--r-- | src/widgets/dialogs/qwizard.cpp | 2 | ||||
-rw-r--r-- | src/widgets/dialogs/qwizard.h | 2 | ||||
-rw-r--r-- | src/widgets/graphicsview/qgraphicsitem.cpp | 3 | ||||
-rw-r--r-- | src/widgets/kernel/qformlayout.cpp | 6 | ||||
-rw-r--r-- | src/widgets/styles/qdrawutil.cpp | 6 | ||||
-rw-r--r-- | src/widgets/styles/qdrawutil.h | 4 | ||||
-rw-r--r-- | src/widgets/widgets/qabstractscrollarea.cpp | 1 | ||||
-rw-r--r-- | src/widgets/widgets/qlineedit.cpp | 2 | ||||
-rw-r--r-- | src/widgets/widgets/qpushbutton.cpp | 2 | ||||
-rw-r--r-- | src/widgets/widgets/qtabwidget.cpp | 2 |
19 files changed, 24 insertions, 28 deletions
diff --git a/qmake/library/proitems.cpp b/qmake/library/proitems.cpp index 66db190bc11..7862ab0e69d 100644 --- a/qmake/library/proitems.cpp +++ b/qmake/library/proitems.cpp @@ -154,7 +154,7 @@ QString &ProString::toQString(QString &tmp) const return tmp.setRawData(m_string.constData() + m_offset, m_length); } -/*! +/* * \brief ProString::prepareExtend * \param extraLen number of new characters to be added * \param thisTarget offset to which current contents should be moved diff --git a/src/corelib/tools/qvsnprintf.cpp b/src/corelib/tools/qvsnprintf.cpp index 472b1f282c9..43a21771a1f 100644 --- a/src/corelib/tools/qvsnprintf.cpp +++ b/src/corelib/tools/qvsnprintf.cpp @@ -46,7 +46,7 @@ QT_BEGIN_NAMESPACE -#ifndef QT_VSNPRINTF +#if !defined(QT_VSNPRINTF) || defined(Q_CLANG_QDOC) /*! \relates QByteArray diff --git a/src/gui/kernel/qevent.cpp b/src/gui/kernel/qevent.cpp index dc61ee91513..ac9edc8eb0f 100644 --- a/src/gui/kernel/qevent.cpp +++ b/src/gui/kernel/qevent.cpp @@ -2939,6 +2939,7 @@ QDragMoveEvent::~QDragMoveEvent() type information. */ +// ### pos is in which coordinate system? /*! Constructs a drop event of a certain \a type corresponding to a drop at the point specified by \a pos in the destination widget's @@ -2949,7 +2950,7 @@ QDragMoveEvent::~QDragMoveEvent() The states of the mouse buttons and keyboard modifiers at the time of the drop are specified by \a buttons and \a modifiers. -*/ // ### pos is in which coordinate system? +*/ QDropEvent::QDropEvent(const QPointF& pos, Qt::DropActions actions, const QMimeData *data, Qt::MouseButtons buttons, Qt::KeyboardModifiers modifiers, Type type) : QEvent(type), p(pos), mouseState(buttons), diff --git a/src/gui/kernel/qplatformwindow.cpp b/src/gui/kernel/qplatformwindow.cpp index 70e2c22ee17..2f8a678c38c 100644 --- a/src/gui/kernel/qplatformwindow.cpp +++ b/src/gui/kernel/qplatformwindow.cpp @@ -277,13 +277,13 @@ WId QPlatformWindow::winId() const return WId(1); } +//jl: It would be useful to have a property on the platform window which indicated if the sub-class +// supported the setParent. If not, then geometry would be in screen coordinates. /*! This function is called to enable native child window in QPA. It is common not to support this feature in Window systems, but can be faked. When this function is called all geometry of this platform window will be relative to the parent. */ -//jl: It would be useful to have a property on the platform window which indicated if the sub-class -// supported the setParent. If not, then geometry would be in screen coordinates. void QPlatformWindow::setParent(const QPlatformWindow *parent) { Q_UNUSED(parent); diff --git a/src/gui/painting/qregion.cpp b/src/gui/painting/qregion.cpp index 0571e1a3286..3fb6f925b3d 100644 --- a/src/gui/painting/qregion.cpp +++ b/src/gui/painting/qregion.cpp @@ -739,7 +739,7 @@ bool QRegion::intersects(const QRegion ®ion) const */ -#if !defined (Q_OS_UNIX) && !defined (Q_OS_WIN) +#if !defined (Q_OS_UNIX) && !defined (Q_OS_WIN) || defined(Q_CLANG_QDOC) /*! \overload \since 4.4 diff --git a/src/network/socket/qabstractsocket.cpp b/src/network/socket/qabstractsocket.cpp index 271b5848c5a..7ecbf354896 100644 --- a/src/network/socket/qabstractsocket.cpp +++ b/src/network/socket/qabstractsocket.cpp @@ -2463,7 +2463,6 @@ bool QAbstractSocket::atEnd() const \sa write(), waitForBytesWritten() */ -// Note! docs copied to QSslSocket::flush() bool QAbstractSocket::flush() { return d_func()->flush(); diff --git a/src/network/ssl/qsslerror.cpp b/src/network/ssl/qsslerror.cpp index c7796519594..3f79d1a037c 100644 --- a/src/network/ssl/qsslerror.cpp +++ b/src/network/ssl/qsslerror.cpp @@ -105,13 +105,13 @@ public: QSslCertificate certificate; }; +// RVCT compiler in debug build does not like about default values in const- +// So as an workaround we define all constructor overloads here explicitly /*! Constructs a QSslError object with no error and default certificate. */ -// RVCT compiler in debug build does not like about default values in const- -// So as an workaround we define all constructor overloads here explicitly QSslError::QSslError() : d(new QSslErrorPrivate) { diff --git a/src/network/ssl/qsslsocket.cpp b/src/network/ssl/qsslsocket.cpp index 2fc779b2573..bb0d949684e 100644 --- a/src/network/ssl/qsslsocket.cpp +++ b/src/network/ssl/qsslsocket.cpp @@ -834,7 +834,6 @@ bool QSslSocket::atEnd() const \sa write(), waitForBytesWritten() */ -// Note! docs copied from QAbstractSocket::flush() bool QSslSocket::flush() { return d_func()->flush(); diff --git a/src/sql/models/qsqlrelationaltablemodel.cpp b/src/sql/models/qsqlrelationaltablemodel.cpp index 66cd98bbe43..bb3717a0a09 100644 --- a/src/sql/models/qsqlrelationaltablemodel.cpp +++ b/src/sql/models/qsqlrelationaltablemodel.cpp @@ -303,9 +303,6 @@ int QSqlRelationalTableModelPrivate::nameToIndex(const QString &name) const return idx; } -/*! - \reimp -*/ void QSqlRelationalTableModelPrivate::clearCache() { for (int i = 0; i < relations.count(); ++i) diff --git a/src/widgets/dialogs/qwizard.cpp b/src/widgets/dialogs/qwizard.cpp index 9153d7ea415..532ee4700ff 100644 --- a/src/widgets/dialogs/qwizard.cpp +++ b/src/widgets/dialogs/qwizard.cpp @@ -3255,7 +3255,7 @@ void QWizard::paintEvent(QPaintEvent * event) #endif } -#if defined(Q_OS_WIN) +#if defined(Q_OS_WIN) || defined(Q_CLANG_QDOC) /*! \reimp */ diff --git a/src/widgets/dialogs/qwizard.h b/src/widgets/dialogs/qwizard.h index 0bf4dfed823..7915c9e7f88 100644 --- a/src/widgets/dialogs/qwizard.h +++ b/src/widgets/dialogs/qwizard.h @@ -188,7 +188,7 @@ protected: bool event(QEvent *event) Q_DECL_OVERRIDE; void resizeEvent(QResizeEvent *event) Q_DECL_OVERRIDE; void paintEvent(QPaintEvent *event) Q_DECL_OVERRIDE; -#ifdef Q_OS_WIN +#if defined(Q_OS_WIN) || defined(Q_CLANG_QDOC) bool nativeEvent(const QByteArray &eventType, void *message, long *result) Q_DECL_OVERRIDE; #endif void done(int result) Q_DECL_OVERRIDE; diff --git a/src/widgets/graphicsview/qgraphicsitem.cpp b/src/widgets/graphicsview/qgraphicsitem.cpp index 6124796073c..b69a523c513 100644 --- a/src/widgets/graphicsview/qgraphicsitem.cpp +++ b/src/widgets/graphicsview/qgraphicsitem.cpp @@ -7191,9 +7191,6 @@ void QGraphicsItem::mousePressEvent(QGraphicsSceneMouseEvent *event) } } -/*! - obsolete -*/ bool _qt_movableAncestorIsSelected(const QGraphicsItem *item) { const QGraphicsItem *parent = item->parentItem(); diff --git a/src/widgets/kernel/qformlayout.cpp b/src/widgets/kernel/qformlayout.cpp index f3f72800306..a06d01be67d 100644 --- a/src/widgets/kernel/qformlayout.cpp +++ b/src/widgets/kernel/qformlayout.cpp @@ -1167,12 +1167,12 @@ QLayoutItem* QFormLayoutPrivate::replaceAt(int index, QLayoutItem *newitem) */ /*! - \since 5.8 - \struct QFormLayout::TakeRowResult + \class QFormLayout::TakeRowResult \brief Contains the result of a QFormLayout::takeRow() call. - + \inmodule QtWidgets + \since 5.8 \sa QFormLayout::takeRow() */ diff --git a/src/widgets/styles/qdrawutil.cpp b/src/widgets/styles/qdrawutil.cpp index fa80a7a6ca5..0b0583ea941 100644 --- a/src/widgets/styles/qdrawutil.cpp +++ b/src/widgets/styles/qdrawutil.cpp @@ -797,7 +797,11 @@ typedef QVarLengthArray<QPainter::PixmapFragment, 16> QPixmapFragmentsArray; void qDrawBorderPixmap(QPainter *painter, const QRect &targetRect, const QMargins &targetMargins, const QPixmap &pixmap, const QRect &sourceRect,const QMargins &sourceMargins, - const QTileRules &rules, QDrawBorderPixmap::DrawingHints hints) + const QTileRules &rules +#ifndef Q_CLANG_QDOC + , QDrawBorderPixmap::DrawingHints hints +#endif + ) { QPainter::PixmapFragment d; d.opacity = 1.0; diff --git a/src/widgets/styles/qdrawutil.h b/src/widgets/styles/qdrawutil.h index 121221dfc91..d5582f2c90b 100644 --- a/src/widgets/styles/qdrawutil.h +++ b/src/widgets/styles/qdrawutil.h @@ -119,7 +119,7 @@ struct QTileRules Qt::TileRule vertical; }; -#ifndef Q_QDOC +#ifndef Q_CLANG_QDOC // For internal use only. namespace QDrawBorderPixmap { @@ -151,7 +151,7 @@ Q_WIDGETS_EXPORT void qDrawBorderPixmap(QPainter *painter, const QRect &sourceRect, const QMargins &sourceMargins, const QTileRules &rules = QTileRules() -#ifndef Q_QDOC +#ifndef Q_CLANG_QDOC , QDrawBorderPixmap::DrawingHints hints = QDrawBorderPixmap::DrawingHints() #endif ); diff --git a/src/widgets/widgets/qabstractscrollarea.cpp b/src/widgets/widgets/qabstractscrollarea.cpp index 5b31e4467fc..aaf7e165cd7 100644 --- a/src/widgets/widgets/qabstractscrollarea.cpp +++ b/src/widgets/widgets/qabstractscrollarea.cpp @@ -637,7 +637,6 @@ QWidget *QAbstractScrollArea::viewport() const Returns the size of the viewport as if the scroll bars had no valid scrolling range. */ -// ### still thinking about the name QSize QAbstractScrollArea::maximumViewportSize() const { Q_D(const QAbstractScrollArea); diff --git a/src/widgets/widgets/qlineedit.cpp b/src/widgets/widgets/qlineedit.cpp index ffe1ca1c662..6d49b29fb9c 100644 --- a/src/widgets/widgets/qlineedit.cpp +++ b/src/widgets/widgets/qlineedit.cpp @@ -737,10 +737,10 @@ void QLineEdit::setCursorPosition(int pos) d->control->setCursorPosition(pos); } +// ### What should this do if the point is outside of contentsRect? Currently returns 0. /*! Returns the cursor position under the point \a pos. */ -// ### What should this do if the point is outside of contentsRect? Currently returns 0. int QLineEdit::cursorPositionAt(const QPoint &pos) { Q_D(QLineEdit); diff --git a/src/widgets/widgets/qpushbutton.cpp b/src/widgets/widgets/qpushbutton.cpp index cb4cbd56bdf..d8eae724ee6 100644 --- a/src/widgets/widgets/qpushbutton.cpp +++ b/src/widgets/widgets/qpushbutton.cpp @@ -678,7 +678,7 @@ bool QPushButton::event(QEvent *e) } #if 0 // Used to be included in Qt4 for Q_WS_MAC -/*! \reimp */ +/* \reimp */ bool QPushButton::hitButton(const QPoint &pos) const { QStyleOptionButton opt; diff --git a/src/widgets/widgets/qtabwidget.cpp b/src/widgets/widgets/qtabwidget.cpp index 5dce76056c8..1394c6b44c7 100644 --- a/src/widgets/widgets/qtabwidget.cpp +++ b/src/widgets/widgets/qtabwidget.cpp @@ -732,7 +732,7 @@ QTabBar* QTabWidget::tabBar() const return d->tabs; } -/*! +/* Ensures that the selected tab's page is visible and appropriately sized. */ |