summaryrefslogtreecommitdiffstats
path: root/src/gui
diff options
context:
space:
mode:
authorMartin Smith <martin.smith@qt.io>2018-01-18 11:40:43 +0100
committerMartin Smith <martin.smith@qt.io>2018-01-24 10:01:26 +0000
commit43fbf30efaffca2b95625f5b04429e5fc31bc770 (patch)
tree319966191bd06976a169cc8ff923dfc4fb0007fa /src/gui
parentd5aaa5635cbcc3b71a4ca695bf3fa7fddf064957 (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/gui')
-rw-r--r--src/gui/kernel/qcursor.cpp6
-rw-r--r--src/gui/opengl/qopenglfunctions.h2
-rw-r--r--src/gui/text/qtextdocument.cpp31
-rw-r--r--src/gui/text/qtextdocument.h2
-rw-r--r--src/gui/text/qtextoption.cpp2
5 files changed, 11 insertions, 32 deletions
diff --git a/src/gui/kernel/qcursor.cpp b/src/gui/kernel/qcursor.cpp
index 8ae9085d9f..bb81ca109a 100644
--- a/src/gui/kernel/qcursor.cpp
+++ b/src/gui/kernel/qcursor.cpp
@@ -172,6 +172,12 @@ QT_BEGIN_NAMESPACE
*/
/*!
+ \fn void QCursor::swap(QCursor &other)
+
+ Swaps this cursor with the \a other cursor.
+ */
+
+/*!
\fn QPoint QCursor::pos(const QScreen *screen)
Returns the position of the cursor (hot spot) of the \a screen
diff --git a/src/gui/opengl/qopenglfunctions.h b/src/gui/opengl/qopenglfunctions.h
index 72af128219..1a43f13d9b 100644
--- a/src/gui/opengl/qopenglfunctions.h
+++ b/src/gui/opengl/qopenglfunctions.h
@@ -234,6 +234,8 @@ typedef int GLint;
typedef int GLsizei;
#undef GLuint
typedef unsigned int GLuint;
+#undef GLubyte
+typedef unsigned int GLubyte;
#undef GLenum
typedef unsigned int GLenum;
#undef GLbitfield
diff --git a/src/gui/text/qtextdocument.cpp b/src/gui/text/qtextdocument.cpp
index 931c9d7490..d95932f4db 100644
--- a/src/gui/text/qtextdocument.cpp
+++ b/src/gui/text/qtextdocument.cpp
@@ -73,19 +73,6 @@ QT_BEGIN_NAMESPACE
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;
- 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.
-*/
bool Qt::mightBeRichText(const QString& text)
{
if (text.isEmpty())
@@ -144,19 +131,6 @@ bool Qt::mightBeRichText(const QString& text)
return false;
}
-
-/*!
- \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()
-*/
QString Qt::convertFromPlainText(const QString &plain, Qt::WhiteSpaceMode mode)
{
int col = 0;
@@ -206,11 +180,6 @@ QString Qt::convertFromPlainText(const QString &plain, Qt::WhiteSpaceMode mode)
}
#ifndef QT_NO_TEXTCODEC
-/*!
- \internal
-
- This function is defined in the \c <QTextDocument> header file.
-*/
QTextCodec *Qt::codecForHtml(const QByteArray &ba)
{
return QTextCodec::codecForHtml(ba);
diff --git a/src/gui/text/qtextdocument.h b/src/gui/text/qtextdocument.h
index 41c578fc1b..c847d3ce88 100644
--- a/src/gui/text/qtextdocument.h
+++ b/src/gui/text/qtextdocument.h
@@ -70,6 +70,7 @@ class QTextCursor;
template<typename T> class QVector;
+#ifndef Q_CLANG_QDOC
namespace Qt
{
Q_GUI_EXPORT bool mightBeRichText(const QString&);
@@ -79,6 +80,7 @@ namespace Qt
Q_GUI_EXPORT QTextCodec *codecForHtml(const QByteArray &ba);
#endif
}
+#endif
class Q_GUI_EXPORT QAbstractUndoItem
{
diff --git a/src/gui/text/qtextoption.cpp b/src/gui/text/qtextoption.cpp
index 310ced5463..a3fa0e7351 100644
--- a/src/gui/text/qtextoption.cpp
+++ b/src/gui/text/qtextoption.cpp
@@ -165,7 +165,7 @@ void QTextOption::setTabArray(const QList<qreal> &tabStops)
Sets the tab positions for the text layout to those specified by
\a tabStops.
- \sa tabStops()
+ \sa tabStop()
*/
void QTextOption::setTabs(const QList<QTextOption::Tab> &tabStops)
{