Documentation fixes.

Change-Id: I2e234ec4307bbe39359cdfa8b13e86661dad43b6
Reviewed-by: Gabriel de Dietrich <gabriel.dedietrich@digia.com>

diff --git a/src/widgets/itemviews/qheaderview.cpp b/src/widgets/itemviews/qheaderview.cpp
index 08b4e4b..6b5b774 100644 (file)
--- a/src/widgets/itemviews/qheaderview.cpp
+++ b/src/widgets/itemviews/qheaderview.cpp
@@ -1119,7 +1119,7 @@ bool QHeaderView::sectionsMovable() const
 // ### Qt 6 - remove this obsolete function
 /*!
     \obsolete
-    \fn bool QHeaderView::isMovable(bool movable) const
+    \fn bool QHeaderView::isMovable() const
 
     Use sectionsMovable instead.
 

diff --git a/src/widgets/kernel/qlayout.cpp b/src/widgets/kernel/qlayout.cpp
index 189f8f3..f2480f7 100644 (file)
--- a/src/widgets/kernel/qlayout.cpp
+++ b/src/widgets/kernel/qlayout.cpp
@@ -286,13 +286,6 @@ bool QLayout::setAlignment(QLayout *l, Qt::Alignment alignment)
 */
 
 /*!
-    \fn bool QLayout::isTopLevel() const
-
-    Returns true if this layout is a top-level layout, i.e. not a
-    child of another layout; otherwise returns false.
-*/
-
-/*!
     \property QLayout::margin
     \brief the width of the outside border of the layout
     \obsolete

diff --git a/src/widgets/kernel/qsizepolicy.qdoc b/src/widgets/kernel/qsizepolicy.qdoc
index 0e08732..e1a941b 100644 (file)
--- a/src/widgets/kernel/qsizepolicy.qdoc
+++ b/src/widgets/kernel/qsizepolicy.qdoc
@@ -146,19 +146,6 @@
 */
 
 /*!
-    \fn QSizePolicy::QSizePolicy(Policy horizontal, Policy vertical)
-
-    Constructs a QSizePolicy object with the given \a horizontal and
-    \a vertical policies, and DefaultType as the control type.
-
-    Use setHeightForWidth() if the preferred height of the widget is
-    dependent on the width of the widget (for example, a QLabel with
-    line wrapping).
-
-    \sa setHorizontalStretch(), setVerticalStretch()
-*/
-
-/*!
     \fn QSizePolicy::QSizePolicy(Policy horizontal, Policy vertical, ControlType type)
     \since 4.3
 

diff --git a/src/widgets/kernel/qwidget.cpp b/src/widgets/kernel/qwidget.cpp
index f929271..626ab31 100644 (file)
--- a/src/widgets/kernel/qwidget.cpp
+++ b/src/widgets/kernel/qwidget.cpp
@@ -10992,14 +10992,6 @@ QGraphicsProxyWidget *QWidget::graphicsProxyWidget() const
 }
 #endif
 
-
-/*!
-    \typedef QWidgetList
-    \relates QWidget
-
-    Synonym for QList<QWidget *>.
-*/
-
 #ifndef QT_NO_GESTURES
 /*!
     Subscribes the widget to a given \a gesture with specific \a flags.
@@ -11031,13 +11023,6 @@ void QWidget::ungrabGesture(Qt::GestureType gesture)
 #endif // QT_NO_GESTURES
 
 /*!
-    \typedef WId
-    \relates QWidget
-
-    Platform dependent window identifier.
-*/
-
-/*!
     \fn void QWidget::destroy(bool destroyWindow, bool destroySubWindows)
 
     Frees up window system resources. Destroys the widget window if \a
@@ -11366,14 +11351,6 @@ void QWidget::clearMask()
     setMask(QRegion());
 }
 
-/*! \fn Qt::HANDLE QWidget::x11PictureHandle() const
-    Returns the X11 Picture handle of the widget for XRender
-    support. Use of this function is not portable. This function will
-    return 0 if XRender support is not compiled into Qt, if the
-    XRender extension is not supported on the X11 display, or if the
-    handle could not be created.
-*/
-
 #ifdef Q_WS_MAC
 void QWidgetPrivate::syncUnifiedMode() {
     // The whole purpose of this method is to keep the unifiedToolbar in sync.

diff --git a/src/widgets/util/qcolormap.qdoc b/src/widgets/util/qcolormap.qdoc
index 86e7162..08981ee 100644 (file)
--- a/src/widgets/util/qcolormap.qdoc
+++ b/src/widgets/util/qcolormap.qdoc
@@ -122,14 +122,6 @@
     \sa size()
 */
 
-/*! \fn HPALETTE QColormap::hPal()
-
-    This function is only available on Windows.
-
-    Returns an handle to the HPALETTE used by this colormap.  If no
-    HPALETTE is being used, this function returns zero.
-*/
-
 /*! \since 4.2
 
     \fn QColormap &QColormap::operator=(const QColormap &colormap)

diff --git a/src/widgets/util/qundostack.cpp b/src/widgets/util/qundostack.cpp
index 47e161f..bb264a8 100644 (file)
--- a/src/widgets/util/qundostack.cpp
+++ b/src/widgets/util/qundostack.cpp
@@ -266,7 +266,7 @@ QString QUndoCommand::actionText() const
     command does.
 
     If you need to have two different strings for text() and actionText(), separate
-    them with "\n" and pass into this function. Even if you do not use this feature
+    them with "\\n" and pass into this function. Even if you do not use this feature
     for English strings during development, you can still let translators use two
     different strings in order to match specific languages' needs.
     The described feature and the function actionText() are available since Qt 4.8.

diff --git a/src/widgets/widgets/qabstractspinbox.cpp b/src/widgets/widgets/qabstractspinbox.cpp
index 25e2fc0..73bf22e 100644 (file)
--- a/src/widgets/widgets/qabstractspinbox.cpp
+++ b/src/widgets/widgets/qabstractspinbox.cpp
@@ -1156,19 +1156,6 @@ void QAbstractSpinBox::hideEvent(QHideEvent *event)
 
 
 /*!
-    \internal
-
-    Used when acceleration is turned on. We need to get the
-    keyboard auto repeat rate from OS. This value is used as
-    argument when starting acceleration related timers.
-
-    Every platform should, either, use native calls to obtain
-    the value or hard code some reasonable rate.
-
-    Remember that time value should be given in msecs.
-*/
-
-/*!
     \reimp
 */
 

diff --git a/src/widgets/widgets/qcalendarwidget.cpp b/src/widgets/widgets/qcalendarwidget.cpp
index 34fe924..ead1dfa 100644 (file)
--- a/src/widgets/widgets/qcalendarwidget.cpp
+++ b/src/widgets/widgets/qcalendarwidget.cpp
@@ -2949,17 +2949,6 @@ void QCalendarWidget::updateCells()
 */
 
 /*!
-    \property QCalendarWidget::headerVisible
-    \brief whether the navigation bar is shown or not
-
-    \obsolete
-
-    Use navigationBarVisible() instead.
-
-    By default, this property is true.
-*/
-
-/*!
     \property QCalendarWidget::navigationBarVisible
     \brief whether the navigation bar is shown or not
 

diff --git a/src/widgets/widgets/qmaccocoaviewcontainer_mac.mm b/src/widgets/widgets/qmaccocoaviewcontainer_mac.mm
index 3aff6ee..c0a46e9 100644 (file)
--- a/src/widgets/widgets/qmaccocoaviewcontainer_mac.mm
+++ b/src/widgets/widgets/qmaccocoaviewcontainer_mac.mm
@@ -85,7 +85,7 @@
     developer to provide the autorelease pool.
 
     The following is a snippet of subclassing QMacCocoaViewContainer to wrap a NSSearchField.
-    \snippet mainwindows/macmainwindow/macmainwindow.mm 0
+    \snippet widgets/mainwindows/macmainwindow/macmainwindow.mm 0
 
 */
 

diff --git a/src/widgets/widgets/qpushbutton.cpp b/src/widgets/widgets/qpushbutton.cpp
index 9853924..1c21817 100644 (file)
--- a/src/widgets/widgets/qpushbutton.cpp
+++ b/src/widgets/widgets/qpushbutton.cpp
@@ -718,30 +718,6 @@ bool QPushButtonPrivate::hitButton(const QPoint &pos)
 #endif // Q_WS_MAC
 
 
-/*!
-    \fn void QPushButton::openPopup()
-
-    Use showMenu() instead.
-*/
-
-/*!
-    \fn bool QPushButton::isMenuButton() const
-
-    Use menu() != 0 instead.
-*/
-
-/*!
-    \fn void QPushButton::setPopup(QMenu* popup)
-
-    Use setMenu() instead.
-*/
-
-/*!
-    \fn QMenu* QPushButton::popup() const
-
-    Use menu() instead.
-*/
-
 QT_END_NAMESPACE
 
 #include "moc_qpushbutton.cpp"

diff --git a/src/widgets/widgets/qstatusbar.cpp b/src/widgets/widgets/qstatusbar.cpp
index 42eb054..ecbd432 100644 (file)
--- a/src/widgets/widgets/qstatusbar.cpp
+++ b/src/widgets/widgets/qstatusbar.cpp
@@ -599,18 +599,6 @@ QString QStatusBar::currentMessage() const
 }
 
 /*!
-    \fn void QStatusBar::message(const QString &message, int timeout)
-
-    Use the showMessage() function instead.
-*/
-
-/*!
-    \fn void QStatusBar::clear()
-
-    Use the clearMessage() function instead.
-*/
-
-/*!
     \fn QStatusBar::messageChanged(const QString &message)
 
     This signal is emitted whenever the temporary status message

diff --git a/src/widgets/widgets/qtoolbar.cpp b/src/widgets/widgets/qtoolbar.cpp
index b2587e6..2d3899a 100644 (file)
--- a/src/widgets/widgets/qtoolbar.cpp
+++ b/src/widgets/widgets/qtoolbar.cpp
@@ -1214,18 +1214,6 @@ QAction *QToolBar::toggleViewAction() const
 { Q_D(const QToolBar); return d->toggleViewAction; }
 
 /*!
-    \fn void QToolBar::setLabel(const QString &label)
-
-    Use setWindowTitle() instead.
-*/
-
-/*!
-    \fn QString QToolBar::label() const
-
-    Use windowTitle() instead.
-*/
-
-/*!
     \since 4.2
 
     Returns the widget associated with the specified \a action.