doc: Fix all remaining non-link qdoc warnings

The fixes included adding missing '!' characters to qdoc comment
markers, correct misspelled words, adding documentation for an
anonymous enum type, and replacing Q_QDOC with Q_CLANG_QDOC.

There remain 12 qdoc link warnings in QtBase.

Change-Id: I00447722e6e029f5aed273b3cd571cef33c119b4
Reviewed-by: Edward Welbourne <edward.welbourne@qt.io>
This commit is contained in:
Martin Smith 2018-01-19 12:16:07 +01:00
parent 046622cdf3
commit 99dc25c686
5 changed files with 22 additions and 8 deletions

View File

@ -891,7 +891,7 @@ bool QThread::isInterruptionRequested() const
return d->running && !d->finished && !d->isInFinish;
}
/*
/*!
\fn template <typename Function, typename... Args> QThread *QThread::create(Function &&f, Args &&... args)
\since 5.10
@ -915,7 +915,7 @@ bool QThread::isInterruptionRequested() const
\sa start()
*/
/*
/*!
\fn template <typename Function> QThread *QThread::create(Function &&f)
\since 5.10

View File

@ -113,7 +113,7 @@ public:
bool event(QEvent *event) override;
int loopLevel() const;
#ifdef Q_QDOC
#ifdef Q_CLANG_QDOC
template <typename Function, typename... Args>
static QThread *create(Function &&f, Args &&... args);
template <typename Function>
@ -128,7 +128,7 @@ public:
static QThread *create(Function &&f);
# endif // QTHREAD_HAS_VARIADIC_CREATE
# endif // QT_CONFIG(cxx11_future)
#endif // Q_QDOC
#endif // Q_CLANG_QDOC
public Q_SLOTS:
void start(Priority = InheritPriority);
@ -169,7 +169,7 @@ private:
#if QT_CONFIG(cxx11_future)
#if defined(QTHREAD_HAS_VARIADIC_CREATE)
#if defined(QTHREAD_HAS_VARIADIC_CREATE) || defined(Q_CLANG_QDOC)
// C++17: std::thread's constructor complying call
template <typename Function, typename... Args>
QThread *QThread::create(Function &&f, Args &&... args)

View File

@ -1230,14 +1230,14 @@ void QMapDataBase::freeData(QMapDataBase *d)
*/
/*!
\fn template <class Key, class T> QPair<iterator, iterator> QMap<Key, T>::equal_range(const Key &key)
\fn template <class Key, class T> QPair<typename QMap<Key, T>::iterator, typename QMap<Key, T>::iterator> QMap<Key, T>::equal_range(const Key &key)
Returns a pair of iterators delimiting the range of values \c{[first, second)}, that
are stored under \a key.
*/
/*!
\fn template <class Key, class T> QPair<const_iterator, const_iterator> QMap<Key, T>::equal_range(const Key &key) const
\fn template <class Key, class T> QPair<typename QMap<Key, T>::const_iterator, typename QMap<Key, T>::const_iterator> QMap<Key, T>::equal_range(const Key &key) const
\overload
\since 5.6
*/

View File

@ -224,6 +224,20 @@ Q_GLOBAL_STATIC(QTimeZoneSingleton, global_tz);
\sa QDateTime
*/
/*!
\enum QTimeZone::anonymous
Sane UTC offsets range from -14 to +14 hours.
No known zone > 12 hrs West of Greenwich (Baker Island, USA).
No known zone > 14 hrs East of Greenwich (Kiritimati, Christmas Island, Kiribati).
\value MinUtcOffsetSecs
-14 * 3600,
\value MaxUtcOffsetSecs
+14 * 3600
*/
/*!
\enum QTimeZone::TimeType

View File

@ -593,7 +593,7 @@ bool QNetworkAddressEntry::isPermanent() const
\value Ethernet IEEE 802.3 Ethernet interfaces, though on many
systems other types of IEEE 802 interfaces may also
be detected as Ethernet (especially Wi-Fi).
\value WiFi IEEE 802.11 Wi-Fi interfaces. Note that on some
\value Wifi IEEE 802.11 Wi-Fi interfaces. Note that on some
systems, QNetworkInterface may be unable to
distinguish regular Ethernet from Wi-Fi and will
not return this enum value.