doc: Add class qualifiers to parameter types

This change supplies several missing class qualifiers for
parameter types and function return types.

Change-Id: I569026e4da0948902fcc13557003d3748b85dd82
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
This commit is contained in:
Martin Smith 2017-03-16 11:38:52 +01:00
parent 929ea50393
commit e827fec40f
8 changed files with 46 additions and 24 deletions

View File

@ -5024,7 +5024,7 @@ bool QObjectPrivate::disconnect(const QObject *sender, int signal_index, void **
*/ */
/*! /*!
Create a copy of the handle to the connection Create a copy of the handle to the \a other connection
*/ */
QMetaObject::Connection::Connection(const QMetaObject::Connection &other) : d_ptr(other.d_ptr) QMetaObject::Connection::Connection(const QMetaObject::Connection &other) : d_ptr(other.d_ptr)
{ {

View File

@ -503,11 +503,15 @@
*/ */
/*! /*!
\fn QSharedPointer::QSharedPointer(std::nullptr_t, Deleter) \fn QSharedPointer::QSharedPointer(std::nullptr_t, Deleter deleter)
\since 5.8 \since 5.8
Creates a QSharedPointer that is null. This is equivalent to the Creates a QSharedPointer that is null. This is equivalent to the
QSharedPointer default constructor. QSharedPointer default constructor.
The \a deleter parameter specifies the custom deleter for this
object. The custom deleter is called, instead of the operator
delete(), when the strong reference count drops to 0.
*/ */
/*! /*!

View File

@ -2134,8 +2134,8 @@ QImage QImage::convertToFormat(Format format, const QVector<QRgb> &colorTable, Q
/*! /*!
\since 5.9 \since 5.9
Changes the \a format of the image without changing the data. Only Changes the format of the image to \a format without changing the
works between formats of the same depth. data. Only works between formats of the same depth.
Returns \c true if successful. Returns \c true if successful.

View File

@ -74,6 +74,8 @@ QT_BEGIN_NAMESPACE
Q_CORE_EXPORT Q_DECL_CONST_FUNCTION unsigned int qt_int_sqrt(unsigned int n); Q_CORE_EXPORT Q_DECL_CONST_FUNCTION unsigned int qt_int_sqrt(unsigned int n);
/*! /*!
\fn bool Qt::mightBeRichText(const QString& text)
Returns \c true if the string \a text is likely to be rich text; Returns \c true if the string \a text is likely to be rich text;
otherwise returns \c false. otherwise returns \c false.
@ -144,6 +146,8 @@ bool Qt::mightBeRichText(const QString& text)
/*! /*!
\fn QString Qt::convertFromPlainText(const QString &plain, Qt::WhiteSpaceMode mode)
Converts the plain text string \a plain to an HTML-formatted Converts the plain text string \a plain to an HTML-formatted
paragraph while preserving most of its look. paragraph while preserving most of its look.

View File

@ -103,9 +103,15 @@ QHstsPolicy::QHstsPolicy() : d(new QHstsPolicyPrivate)
} }
/*! /*!
Constructs QHstsPolicy with \a expiry (in UTC): \enum QHstsPolicy::PolicyFlag
- \a host data is interpreted according to \a mode;
- \a flags selects options to apply to this policy. \value IncludeSubDomains Indicates whether a policy must include subdomains
*/
/*!
Constructs QHstsPolicy with \a expiry (in UTC); \a flags is a value indicating
whether this policy must also include subdomains, \a host data is interpreted
according to \a mode.
\sa QUrl::setHost(), QUrl::ParsingMode, QHstsPolicy::PolicyFlag \sa QUrl::setHost(), QUrl::ParsingMode, QHstsPolicy::PolicyFlag
*/ */
@ -213,4 +219,10 @@ bool QHstsPolicy::isExpired() const
return !d->expiry.isValid() || d->expiry <= QDateTime::currentDateTimeUtc(); return !d->expiry.isValid() || d->expiry <= QDateTime::currentDateTimeUtc();
} }
/*!
\fn void QHstsPolicy::swap(QHstsPolicy &other)
Swaps this policy with the \a other policy.
*/
QT_END_NAMESPACE QT_END_NAMESPACE

View File

@ -781,7 +781,9 @@ bool QNetworkAccessManager::isStrictTransportSecurityStoreEnabled() const
/*! /*!
\since 5.9 \since 5.9
Adds HTTP Strict Transport Security policies contained in \a knownHosts into HSTS cache. Adds HTTP Strict Transport Security policies into HSTS cache.
\a knownHosts contains the known hosts that have QHstsPolicy
information.
\note An expired policy will remove a known host from the cache, if previously \note An expired policy will remove a known host from the cache, if previously
present. present.

View File

@ -87,7 +87,7 @@
/*! /*!
\enum QMacStyle::WidgetSizePolicy \enum QStyleHelper::WidgetSizePolicy
\value SizeSmall \value SizeSmall
\value SizeLarge \value SizeLarge
@ -123,7 +123,7 @@
\reimp \reimp
*/ */
/*! \fn int QMacStyle::pixelMetric(PixelMetric metric, const QStyleOption *opt, const QWidget *widget) const /*! \fn int QMacStyle::pixelMetric(QStyle::PixelMetric metric, const QStyleOption *opt, const QWidget *widget) const
\reimp \reimp
*/ */
@ -131,7 +131,7 @@
\reimp \reimp
*/ */
/*! \fn int QMacStyle::styleHint(StyleHint sh, const QStyleOption *opt, const QWidget *w, QStyleHintReturn *hret) const /*! \fn int QMacStyle::styleHint(QStyle::StyleHint sh, const QStyleOption *opt, const QWidget *w, QStyleHintReturn *hret) const
\reimp \reimp
*/ */
@ -139,11 +139,11 @@
\reimp \reimp
*/ */
/*! \fn QPixmap QMacStyle::standardPixmap(StandardPixmap standardPixmap, const QStyleOption *opt, const QWidget *widget) const /*! \fn QPixmap QMacStyle::standardPixmap(QStyle::StandardPixmap standardPixmap, const QStyleOption *opt, const QWidget *widget) const
\reimp \reimp
*/ */
/*! \fn void QMacStyle::setWidgetSizePolicy(const QWidget *widget, WidgetSizePolicy policy) /*! \fn void QStyleHelper::setWidgetSizePolicy(const QWidget *widget, QStyleHelper::WidgetSizePolicy policy)
\obsolete \obsolete
@ -151,41 +151,41 @@
or Qt::WA_MacNormalSize instead. or Qt::WA_MacNormalSize instead.
*/ */
/*! \fn QMacStyle::WidgetSizePolicy QMacStyle::widgetSizePolicy(const QWidget *widget, const QStyleOption *opt = 0) /*! \fn QStyleHelper::WidgetSizePolicy QStyleHelper::widgetSizePolicy(const QWidget *widget, const QStyleOption *opt)
\obsolete \obsolete
Call QWidget::testAttribute() with Qt::WA_MacMiniSize, Qt::WA_MacSmallSize, Call QWidget::testAttribute() with Qt::WA_MacMiniSize, Qt::WA_MacSmallSize,
or Qt::WA_MacNormalSize instead. or Qt::WA_MacNormalSize instead.
*/ */
/*! \fn void QMacStyle::drawPrimitive(PrimitiveElement pe, const QStyleOption *opt, QPainter *p, const QWidget *w) const /*! \fn void QMacStyle::drawPrimitive(QStyle::PrimitiveElement pe, const QStyleOption *opt, QPainter *p, const QWidget *w) const
\reimp \reimp
*/ */
/*! \fn void QMacStyle::drawControl(ControlElement ce, const QStyleOption *opt, QPainter *p, const QWidget *w) const /*! \fn void QMacStyle::drawControl(QStyle::ControlElement ce, const QStyleOption *opt, QPainter *p, const QWidget *w) const
\reimp \reimp
*/ */
/*! \fn QRect QMacStyle::subElementRect(SubElement sr, const QStyleOption *opt, const QWidget *widget) const /*! \fn QRect QMacStyle::subElementRect(QStyle::SubElement sr, const QStyleOption *opt, const QWidget *widget) const
\reimp \reimp
*/ */
/*! \fn void QMacStyle::drawComplexControl(ComplexControl cc, const QStyleOptionComplex *opt, QPainter *p, const QWidget *widget) const /*! \fn void QMacStyle::drawComplexControl(QStyle::ComplexControl cc, const QStyleOptionComplex *opt, QPainter *p, const QWidget *widget) const
\reimp \reimp
*/ */
/*! \fn QStyle::SubControl QMacStyle::hitTestComplexControl(ComplexControl cc, const QStyleOptionComplex *opt, const QPoint &pt, const QWidget *widget) const /*! \fn QStyle::SubControl QMacStyle::hitTestComplexControl(QStyle::ComplexControl cc, const QStyleOptionComplex *opt, const QPoint &pt, const QWidget *widget) const
\reimp \reimp
*/ */
/*! \fn QRect QMacStyle::subControlRect(ComplexControl cc, const QStyleOptionComplex *opt, SubControl sc, const QWidget *widget) const /*! \fn QRect QMacStyle::subControlRect(QStyle::ComplexControl cc, const QStyleOptionComplex *opt, QStyle::SubControl sc, const QWidget *widget) const
\reimp \reimp
*/ */
/*! \fn QSize QMacStyle::sizeFromContents(ContentsType ct, const QStyleOption *opt, const QSize &csz, const QWidget *widget) const /*! \fn QSize QMacStyle::sizeFromContents(QStyle::ContentsType ct, const QStyleOption *opt, const QSize &csz, const QWidget *widget) const
\reimp \reimp
*/ */
@ -197,7 +197,7 @@
\reimp \reimp
*/ */
/*! \fn QIcon QMacStyle::standardIcon(StandardPixmap standardIcon, const QStyleOption *opt, const QWidget *widget) const /*! \fn QIcon QMacStyle::standardIcon(QStyle::StandardPixmap standardIcon, const QStyleOption *opt, const QWidget *widget) const
\reimp \reimp
*/ */

View File

@ -400,8 +400,8 @@ int QLayoutItem::minimumHeightForWidth(int w) const
/*! /*!
Returns the preferred height for this layout item, given the width Returns the preferred height for this layout item, given the
\a w. width, which is not used in this default implementation.
The default implementation returns -1, indicating that the The default implementation returns -1, indicating that the
preferred height is independent of the width of the item. Using preferred height is independent of the width of the item. Using