diff options
author | Martin Smith <martin.smith@qt.io> | 2018-01-18 11:40:43 +0100 |
---|---|---|
committer | Martin Smith <martin.smith@qt.io> | 2018-01-24 10:01:26 +0000 |
commit | 43fbf30efaffca2b95625f5b04429e5fc31bc770 (patch) | |
tree | 319966191bd06976a169cc8ff923dfc4fb0007fa /src/corelib/global | |
parent | d5aaa5635cbcc3b71a4ca695bf3fa7fddf064957 (diff) |
doc: Fix many qdoc warnings, mostly missing return types
Fixed many cases of missing return types in \fn commands.
Added a fake GLxxx typedef for a GL type that wasn't there
because the GL includes weren't accessible. Also added some
fake declarations for a few functions declared in namespace
Qt in QtWidgets that must be seen by qdoc in QtCore.
Change-Id: Id82476042d0563d32fa85c4ae81a58c1298a468a
Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io>
Diffstat (limited to 'src/corelib/global')
-rw-r--r-- | src/corelib/global/qnamespace.h | 10 | ||||
-rw-r--r-- | src/corelib/global/qnamespace.qdoc | 34 |
2 files changed, 44 insertions, 0 deletions
diff --git a/src/corelib/global/qnamespace.h b/src/corelib/global/qnamespace.h index 05383d00b6..fb40c71f7a 100644 --- a/src/corelib/global/qnamespace.h +++ b/src/corelib/global/qnamespace.h @@ -1861,6 +1861,16 @@ public: static bool activateCallbacks(Callback, void **); }; +#if defined(Q_CLANG_QDOC) +// Declared here for qdoc; actual declarations in qtextdocument.h +namespace Qt +{ + bool mightBeRichText(const QString&); + QString convertFromPlainText(const QString &plain, WhiteSpaceMode mode = WhiteSpacePre); + QTextCodec *codecForHtml(const QByteArray &ba); +} +#endif // Q_CLANG_QDOC + QT_END_NAMESPACE #endif // QNAMESPACE_H diff --git a/src/corelib/global/qnamespace.qdoc b/src/corelib/global/qnamespace.qdoc index 2614a0bfd9..dd0b18dfa0 100644 --- a/src/corelib/global/qnamespace.qdoc +++ b/src/corelib/global/qnamespace.qdoc @@ -3222,3 +3222,37 @@ \value ChecksumItuV41 Checksum calculation based on ITU-V.41. */ + +/*! + \fn bool Qt::mightBeRichText(const QString& text) + + Returns \c true if the string \a text is likely to be rich text; + otherwise returns \c false. + + This function uses a fast and therefore simple heuristic. It + mainly checks whether there is something that looks like a tag + before the first line break. Although the result may be correct + for common cases, there is no guarantee. + + This function is defined in the \c <QTextDocument> header file. +*/ + +/*! + \fn QString Qt::convertFromPlainText(const QString &plain, Qt::WhiteSpaceMode mode) + + Converts the plain text string \a plain to an HTML-formatted + paragraph while preserving most of its look. + + \a mode defines how whitespace is handled. + + This function is defined in the \c <QTextDocument> header file. + + \sa escape(), mightBeRichText() +*/ + +/*! + \fn QTextCodec *Qt::codecForHtml(const QByteArray &ba) + \internal + + This function is defined in the \c <QTextDocument> header file. +*/ |