From 1dc517abc688f6cf20bdc75e8a4ff2dda86b5d70 Mon Sep 17 00:00:00 2001 From: Frederik Gladhorn Date: Thu, 20 Sep 2012 16:57:49 +0200 Subject: [PATCH] Documentation fixes. Change-Id: I2e234ec4307bbe39359cdfa8b13e86661dad43b6 Reviewed-by: Gabriel de Dietrich --- src/widgets/itemviews/qheaderview.cpp | 2 +- src/widgets/kernel/qlayout.cpp | 7 ------ src/widgets/kernel/qsizepolicy.qdoc | 13 ---------- src/widgets/kernel/qwidget.cpp | 23 ------------------ src/widgets/util/qcolormap.qdoc | 8 ------- src/widgets/util/qundostack.cpp | 2 +- src/widgets/widgets/qabstractspinbox.cpp | 13 ---------- src/widgets/widgets/qcalendarwidget.cpp | 11 --------- .../widgets/qmaccocoaviewcontainer_mac.mm | 2 +- src/widgets/widgets/qpushbutton.cpp | 24 ------------------- src/widgets/widgets/qstatusbar.cpp | 12 ---------- src/widgets/widgets/qtoolbar.cpp | 12 ---------- 12 files changed, 3 insertions(+), 126 deletions(-) diff --git a/src/widgets/itemviews/qheaderview.cpp b/src/widgets/itemviews/qheaderview.cpp index 08b4e4bcb1b..6b5b7740498 100644 --- 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 189f8f3451a..f2480f74d9c 100644 --- a/src/widgets/kernel/qlayout.cpp +++ b/src/widgets/kernel/qlayout.cpp @@ -285,13 +285,6 @@ bool QLayout::setAlignment(QLayout *l, Qt::Alignment alignment) \sa QLayoutItem::setAlignment() */ -/*! - \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 diff --git a/src/widgets/kernel/qsizepolicy.qdoc b/src/widgets/kernel/qsizepolicy.qdoc index 0e08732d3e1..e1a941b3d62 100644 --- a/src/widgets/kernel/qsizepolicy.qdoc +++ b/src/widgets/kernel/qsizepolicy.qdoc @@ -145,19 +145,6 @@ \sa setHorizontalStretch(), setVerticalStretch() */ -/*! - \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 f929271f395..626ab31fada 100644 --- 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. -*/ - #ifndef QT_NO_GESTURES /*! Subscribes the widget to a given \a gesture with specific \a flags. @@ -11030,13 +11022,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) @@ -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 86e7162cc9c..08981eea6f7 100644 --- 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 47e161f0592..bb264a834c6 100644 --- 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 25e2fc0eeb2..73bf22ee262 100644 --- a/src/widgets/widgets/qabstractspinbox.cpp +++ b/src/widgets/widgets/qabstractspinbox.cpp @@ -1155,19 +1155,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 34fe9242458..ead1dfa6e38 100644 --- a/src/widgets/widgets/qcalendarwidget.cpp +++ b/src/widgets/widgets/qcalendarwidget.cpp @@ -2948,17 +2948,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 3aff6ee5d9e..c0a46e95680 100644 --- 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 98539241829..1c2181732e1 100644 --- 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 42eb0543656..ecbd43271c4 100644 --- a/src/widgets/widgets/qstatusbar.cpp +++ b/src/widgets/widgets/qstatusbar.cpp @@ -598,18 +598,6 @@ QString QStatusBar::currentMessage() const return d->tempItem; } -/*! - \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) diff --git a/src/widgets/widgets/qtoolbar.cpp b/src/widgets/widgets/qtoolbar.cpp index b2587e64ddf..2d3899ab0c0 100644 --- a/src/widgets/widgets/qtoolbar.cpp +++ b/src/widgets/widgets/qtoolbar.cpp @@ -1213,18 +1213,6 @@ bool QToolBar::event(QEvent *event) 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