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ö <topi.reinio@qt.io>
This commit is contained in:
parent
ed6b6bc039
commit
45ff1cf60a
@ -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
|
||||
|
@ -46,7 +46,7 @@
|
||||
|
||||
QT_BEGIN_NAMESPACE
|
||||
|
||||
#ifndef QT_VSNPRINTF
|
||||
#if !defined(QT_VSNPRINTF) || defined(Q_CLANG_QDOC)
|
||||
|
||||
/*!
|
||||
\relates QByteArray
|
||||
|
@ -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),
|
||||
|
@ -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);
|
||||
|
@ -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
|
||||
|
@ -2463,7 +2463,6 @@ bool QAbstractSocket::atEnd() const
|
||||
|
||||
\sa write(), waitForBytesWritten()
|
||||
*/
|
||||
// Note! docs copied to QSslSocket::flush()
|
||||
bool QAbstractSocket::flush()
|
||||
{
|
||||
return d_func()->flush();
|
||||
|
@ -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)
|
||||
{
|
||||
|
@ -834,7 +834,6 @@ bool QSslSocket::atEnd() const
|
||||
|
||||
\sa write(), waitForBytesWritten()
|
||||
*/
|
||||
// Note! docs copied from QAbstractSocket::flush()
|
||||
bool QSslSocket::flush()
|
||||
{
|
||||
return d_func()->flush();
|
||||
|
@ -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)
|
||||
|
@ -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
|
||||
*/
|
||||
|
@ -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;
|
||||
|
@ -7191,9 +7191,6 @@ void QGraphicsItem::mousePressEvent(QGraphicsSceneMouseEvent *event)
|
||||
}
|
||||
}
|
||||
|
||||
/*!
|
||||
obsolete
|
||||
*/
|
||||
bool _qt_movableAncestorIsSelected(const QGraphicsItem *item)
|
||||
{
|
||||
const QGraphicsItem *parent = item->parentItem();
|
||||
|
@ -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()
|
||||
*/
|
||||
|
||||
|
@ -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;
|
||||
|
@ -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
|
||||
);
|
||||
|
@ -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);
|
||||
|
@ -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);
|
||||
|
@ -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;
|
||||
|
@ -732,7 +732,7 @@ QTabBar* QTabWidget::tabBar() const
|
||||
return d->tabs;
|
||||
}
|
||||
|
||||
/*!
|
||||
/*
|
||||
Ensures that the selected tab's page is visible and appropriately
|
||||
sized.
|
||||
*/
|
||||
|
Loading…
Reference in New Issue
Block a user