diff options
author | Friedemann Kleint <[email protected]> | 2015-07-09 14:52:22 +0200 |
---|---|---|
committer | Friedemann Kleint <[email protected]> | 2015-07-10 18:01:39 +0000 |
commit | a299ae3dc4de9d62bb2b433a50a6464b7f9f2595 (patch) | |
tree | 891a6fef8ca4426371df0fa6d6b15bafaeba5566 | |
parent | 19751d368a5cb1de0487015c6a3ebf7677894181 (diff) |
Fix some qdoc-warnings.
qtbase/src/corelib/io/qdatastream.cpp:501: warning: Undocumented enum item 'Qt_5_6' in QDataStream::Version
qtbase/src/corelib/itemmodels/qitemselectionmodel.cpp:1764: warning: Undocumented parameter 'model' in QItemSelectionModel::setModel()
qtbase/src/corelib/statemachine/qabstractstate.cpp:216: warning: Undocumented parameter 'active' in QAbstractState::activeChanged()
qtbase/src/corelib/statemachine/qstatemachine.cpp:3262: warning: Undocumented parameter 'running' in QStateMachine::runningChanged()
qtbase/src/corelib/tools/qchar.cpp:160: warning: Undocumented enum item 'Unicode_7_0' in QChar::UnicodeVersion
qtbase/src/gui/image/qimagereader.cpp:1168: warning: Undocumented parameter 'enabled' in QImageReader::setAutoTransform()
qtbase/src/gui/image/qimagewriter.cpp:621: warning: Undocumented parameter 'transform' in QImageWriter::setTransformation()
qtbase/src/gui/itemmodels/qstandarditemmodel.cpp:1268: warning: Undocumented parameter 'tristate' in QStandardItem::setAutoTristate()
qtbase/src/gui/kernel/qscreen.cpp:590: warning: Undocumented parameter 'orientation' in QScreen::orientationChanged()
qtbase/src/gui/kernel/qscreen.cpp:599: warning: Undocumented parameter 'orientation' in QScreen::primaryOrientationChanged()
qtbase/src/gui/text/qtextdocument.cpp:1455: warning: No such parameter 'from' in QTextDocument::find()
qtbase/src/gui/text/qtextdocument.cpp:533: warning: Undocumented parameter 'option' in QTextDocument::setDefaultTextOption()
qtbase/src/widgets/itemviews/qtableview.cpp:2546: warning: Undocumented parameter 'enable' in QTableView::setSortingEnabled()
qtbase/src/widgets/statemachine/qkeyeventtransition.cpp:119: warning: Undocumented parameter 'key' in QKeyEventTransition::setKey()
qtbase/src/widgets/widgets/qplaintextedit.cpp:1610: warning: Can't link to 'toText()'
qtbase/src/opengl/qgl.cpp:4371: warning: No documentation for 'QGLWidget::event()'
Remove the documentation as they are properties:
qtbase/src/widgets/widgets/qfontcombobox.cpp:407: warning: Undocumented parameter 'font' in QFontComboBox::setCurrentFont()
qtbase/src/widgets/widgets/qfontcombobox.cpp:403: warning: Undocumented parameter 'script' in QFontComboBox::setWritingSystem()
Change-Id: If599a3ce747bbb8a3418dd973810923b87246371
Reviewed-by: Leena Miettinen <[email protected]>
-rw-r--r-- | src/corelib/io/qdatastream.cpp | 1 | ||||
-rw-r--r-- | src/corelib/itemmodels/qitemselectionmodel.cpp | 2 | ||||
-rw-r--r-- | src/corelib/statemachine/qabstractstate.cpp | 2 | ||||
-rw-r--r-- | src/corelib/statemachine/qstatemachine.cpp | 2 | ||||
-rw-r--r-- | src/corelib/tools/qchar.cpp | 1 | ||||
-rw-r--r-- | src/gui/image/qimagereader.cpp | 5 | ||||
-rw-r--r-- | src/gui/image/qimagewriter.cpp | 2 | ||||
-rw-r--r-- | src/gui/itemmodels/qstandarditemmodel.cpp | 3 | ||||
-rw-r--r-- | src/gui/kernel/qscreen.cpp | 4 | ||||
-rw-r--r-- | src/gui/text/qtextdocument.cpp | 4 | ||||
-rw-r--r-- | src/opengl/qgl.cpp | 2 | ||||
-rw-r--r-- | src/widgets/graphicsview/qgraphicswidget.cpp | 1 | ||||
-rw-r--r-- | src/widgets/itemviews/qtableview.cpp | 2 | ||||
-rw-r--r-- | src/widgets/statemachine/qkeyeventtransition.cpp | 2 | ||||
-rw-r--r-- | src/widgets/widgets/qfontcombobox.cpp | 8 | ||||
-rw-r--r-- | src/widgets/widgets/qplaintextedit.cpp | 2 |
16 files changed, 21 insertions, 22 deletions
diff --git a/src/corelib/io/qdatastream.cpp b/src/corelib/io/qdatastream.cpp index 48672db2e98..713b5a2f55d 100644 --- a/src/corelib/io/qdatastream.cpp +++ b/src/corelib/io/qdatastream.cpp @@ -526,6 +526,7 @@ void QDataStream::setByteOrder(ByteOrder bo) \value Qt_5_3 Same as Qt_5_2 \value Qt_5_4 Version 16 (Qt 5.4) \value Qt_5_5 Same as Qt_5_4 + \value Qt_5_6 Same as Qt_5_4 \omitvalue Qt_DefaultCompiledVersion \sa setVersion(), version() diff --git a/src/corelib/itemmodels/qitemselectionmodel.cpp b/src/corelib/itemmodels/qitemselectionmodel.cpp index 47fcab9b24a..65b76ca6a0b 100644 --- a/src/corelib/itemmodels/qitemselectionmodel.cpp +++ b/src/corelib/itemmodels/qitemselectionmodel.cpp @@ -1764,7 +1764,7 @@ const QAbstractItemModel *QItemSelectionModel::model() const /*! \since 5.5 - Sets the model. The modelChanged() signal will be emitted. + Sets the model to \a model. The modelChanged() signal will be emitted. \sa model(), modelChanged() */ diff --git a/src/corelib/statemachine/qabstractstate.cpp b/src/corelib/statemachine/qabstractstate.cpp index ba904648d8a..2c412849e80 100644 --- a/src/corelib/statemachine/qabstractstate.cpp +++ b/src/corelib/statemachine/qabstractstate.cpp @@ -217,7 +217,7 @@ bool QAbstractState::active() const \fn QAbstractState::activeChanged(bool active) \since 5.4 - This signal is emitted when the active property is changed. + This signal is emitted when the active property is changed with \a active as argument. \sa QAbstractState::active, entered(), exited() */ diff --git a/src/corelib/statemachine/qstatemachine.cpp b/src/corelib/statemachine/qstatemachine.cpp index c93eb541289..c25a6eb5bf9 100644 --- a/src/corelib/statemachine/qstatemachine.cpp +++ b/src/corelib/statemachine/qstatemachine.cpp @@ -3263,7 +3263,7 @@ QStateMachine::WrappedEvent::~WrappedEvent() \fn QStateMachine::runningChanged(bool running) \since 5.4 - This signal is emitted when the running property is changed. + This signal is emitted when the running property is changed with \a running as argument. \sa QStateMachine::running */ diff --git a/src/corelib/tools/qchar.cpp b/src/corelib/tools/qchar.cpp index 56904c91d7d..e6c246e8e68 100644 --- a/src/corelib/tools/qchar.cpp +++ b/src/corelib/tools/qchar.cpp @@ -178,6 +178,7 @@ QT_BEGIN_NAMESPACE \value Unicode_6_1 Version 6.1 \value Unicode_6_2 Version 6.2 \value Unicode_6_3 Version 6.3 Since Qt 5.3 + \value Unicode_7_0 Version 7.0 Since Qt 5.5 \value Unicode_Unassigned The value is not assigned to any character in version 6.3 of Unicode. diff --git a/src/gui/image/qimagereader.cpp b/src/gui/image/qimagereader.cpp index 83ec91bb404..cbe241c5774 100644 --- a/src/gui/image/qimagereader.cpp +++ b/src/gui/image/qimagereader.cpp @@ -1168,9 +1168,10 @@ QImageIOHandler::Transformations QImageReader::transformation() const /*! \since 5.5 - Sets if images returned by read() should have transformation metadata automatically applied. + Determines that images returned by read() should have transformation metadata automatically + applied if \a enabled is \c true. - \sa autoTransform(), transform(), read() + \sa autoTransform(), read() */ void QImageReader::setAutoTransform(bool enabled) { diff --git a/src/gui/image/qimagewriter.cpp b/src/gui/image/qimagewriter.cpp index e9de1db4b2d..5c1a5c7ab12 100644 --- a/src/gui/image/qimagewriter.cpp +++ b/src/gui/image/qimagewriter.cpp @@ -621,7 +621,7 @@ bool QImageWriter::progressiveScanWrite() const /*! \since 5.5 - Sets the image transformations metadata including orientation. + Sets the image transformations metadata including orientation to \a transform. If transformation metadata is not supported by the image format, the transform is applied before writing. diff --git a/src/gui/itemmodels/qstandarditemmodel.cpp b/src/gui/itemmodels/qstandarditemmodel.cpp index c5006d88ede..25b82b94b59 100644 --- a/src/gui/itemmodels/qstandarditemmodel.cpp +++ b/src/gui/itemmodels/qstandarditemmodel.cpp @@ -1266,7 +1266,8 @@ void QStandardItem::setCheckable(bool checkable) */ /*! - Sets whether the item is tristate and controlled by QTreeWidget. + Determines that the item is tristate and controlled by QTreeWidget if \a tristate + is \c true. This enables automatic management of the state of parent items in QTreeWidget (checked if all children are checked, unchecked if all children are unchecked, or partially checked if only some children are checked). diff --git a/src/gui/kernel/qscreen.cpp b/src/gui/kernel/qscreen.cpp index 1e0d4f766aa..8398f02a5b8 100644 --- a/src/gui/kernel/qscreen.cpp +++ b/src/gui/kernel/qscreen.cpp @@ -591,7 +591,7 @@ bool QScreen::isLandscape(Qt::ScreenOrientation o) const \fn void QScreen::orientationChanged(Qt::ScreenOrientation orientation) This signal is emitted when the orientation of the screen - changes. + changes with \a orientation as an argument. \sa orientation() */ @@ -600,7 +600,7 @@ bool QScreen::isLandscape(Qt::ScreenOrientation o) const \fn void QScreen::primaryOrientationChanged(Qt::ScreenOrientation orientation) This signal is emitted when the primary orientation of the screen - changes. + changes with \a orientation as an argument. \sa primaryOrientation() */ diff --git a/src/gui/text/qtextdocument.cpp b/src/gui/text/qtextdocument.cpp index 3d248f4afc6..b4efc5a957b 100644 --- a/src/gui/text/qtextdocument.cpp +++ b/src/gui/text/qtextdocument.cpp @@ -533,7 +533,7 @@ QTextOption QTextDocument::defaultTextOption() const /*! \since 4.3 - Sets the default text option. + Sets the default text option to \a option. */ void QTextDocument::setDefaultTextOption(const QTextOption &option) { @@ -1464,7 +1464,7 @@ QTextCursor QTextDocument::find(const QRegExp & expr, int from, FindFlags option Returns a cursor with the match selected if a match was found; otherwise returns a null cursor. - If the given \a from cursor has a selection, the search begins after the + If the given \a cursor has a selection, the search begins after the selection; otherwise it begins at the cursor's position. By default the search is case-sensitive, and can match text anywhere in the diff --git a/src/opengl/qgl.cpp b/src/opengl/qgl.cpp index 0cb4ccd416e..c62e09b3f32 100644 --- a/src/opengl/qgl.cpp +++ b/src/opengl/qgl.cpp @@ -4354,6 +4354,8 @@ void QGLWidget::resizeOverlayGL(int, int) { } +/*!\reimp + */ bool QGLWidget::event(QEvent *e) { Q_D(QGLWidget); diff --git a/src/widgets/graphicsview/qgraphicswidget.cpp b/src/widgets/graphicsview/qgraphicswidget.cpp index 6f10e2854c8..67311ed2c34 100644 --- a/src/widgets/graphicsview/qgraphicswidget.cpp +++ b/src/widgets/graphicsview/qgraphicswidget.cpp @@ -304,6 +304,7 @@ void QGraphicsWidget::resize(const QSizeF &size) /*! \fn void QGraphicsWidget::resize(qreal w, qreal h) + \overload This convenience function is equivalent to calling resize(QSizeF(w, h)). diff --git a/src/widgets/itemviews/qtableview.cpp b/src/widgets/itemviews/qtableview.cpp index 238cbf3bcdf..3e3e3099c89 100644 --- a/src/widgets/itemviews/qtableview.cpp +++ b/src/widgets/itemviews/qtableview.cpp @@ -2544,7 +2544,7 @@ void QTableView::setColumnHidden(int column, bool hide) */ /*! - If \a enabled true enables sorting for the table and immediately + If \a enable is true, enables sorting for the table and immediately trigger a call to sortByColumn() with the current sort section and order */ diff --git a/src/widgets/statemachine/qkeyeventtransition.cpp b/src/widgets/statemachine/qkeyeventtransition.cpp index 3283003e2e9..67af85dd27a 100644 --- a/src/widgets/statemachine/qkeyeventtransition.cpp +++ b/src/widgets/statemachine/qkeyeventtransition.cpp @@ -117,7 +117,7 @@ int QKeyEventTransition::key() const } /*! - Sets the key that this key event transition will check for. + Sets the \a key that this key event transition will check for. */ void QKeyEventTransition::setKey(int key) { diff --git a/src/widgets/widgets/qfontcombobox.cpp b/src/widgets/widgets/qfontcombobox.cpp index faa2f41a511..957d148c740 100644 --- a/src/widgets/widgets/qfontcombobox.cpp +++ b/src/widgets/widgets/qfontcombobox.cpp @@ -401,14 +401,6 @@ void QFontComboBoxPrivate::_q_currentChanged(const QString &text) */ /*! - \fn void QFontComboBox::setWritingSystem(QFontDatabase::WritingSystem script) -*/ - -/*! - \fn void QFontComboBox::setCurrentFont(const QFont &font); -*/ - -/*! Constructs a font combobox with the given \a parent. */ QFontComboBox::QFontComboBox(QWidget *parent) diff --git a/src/widgets/widgets/qplaintextedit.cpp b/src/widgets/widgets/qplaintextedit.cpp index 93c9ddc285f..91788a33834 100644 --- a/src/widgets/widgets/qplaintextedit.cpp +++ b/src/widgets/widgets/qplaintextedit.cpp @@ -1615,7 +1615,7 @@ void QPlainTextEdit::timerEvent(QTimerEvent *e) Note that the undo/redo history is cleared by this function. - \sa toText() + \sa toPlainText() */ void QPlainTextEdit::setPlainText(const QString &text) |