summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJerome Pasion <jerome.pasion@qt.io>2025-11-18 13:41:48 +0100
committerJerome Pasion <jerome.pasion@qt.io>2025-12-01 10:18:32 +0100
commitd5e85e3109df40d6b45733dfddada52281afeb1f (patch)
treee5085f80f265a3d8935aa4ce8ee92f3a0199031f
parentc1341b7557ce52c681618c77c17687623fc0f3b2 (diff)
Doc: Fix QDoc warnings for internal classes in Qt Widgets
-Internal classes should have internal class documentation. Task-number: QTBUG-141665 Change-Id: I399e0cec51a9308172301a862dcd07e6137e9854 Reviewed-by: Richard Moe Gustavsen <richard.gustavsen@qt.io>
-rw-r--r--src/widgets/accessible/qaccessiblemenu.cpp5
-rw-r--r--src/widgets/accessible/qaccessiblewidget.cpp5
-rw-r--r--src/widgets/accessible/rangecontrols.cpp12
-rw-r--r--src/widgets/dialogs/qfiledialog.cpp6
-rw-r--r--src/widgets/dialogs/qsidebar.cpp5
-rw-r--r--src/widgets/graphicsview/qgraphicsscene.cpp6
-rw-r--r--src/widgets/graphicsview/qgraphicsscenebsptreeindex.cpp4
-rw-r--r--src/widgets/graphicsview/qgraphicssceneindex.cpp4
-rw-r--r--src/widgets/graphicsview/qgraphicsview.cpp6
-rw-r--r--src/widgets/itemviews/qcolumnviewgrip.cpp15
-rw-r--r--src/widgets/itemviews/qlistview.cpp6
-rw-r--r--src/widgets/itemviews/qlistwidget.cpp6
-rw-r--r--src/widgets/itemviews/qtreeview.cpp6
-rw-r--r--src/widgets/itemviews/qtreewidget.cpp6
-rw-r--r--src/widgets/kernel/qapplication.cpp6
-rw-r--r--src/widgets/kernel/qlayout.cpp6
-rw-r--r--src/widgets/kernel/qwidgetrepaintmanager.cpp12
-rw-r--r--src/widgets/util/qflickgesture.cpp6
-rw-r--r--src/widgets/widgets/qcombobox.cpp6
-rw-r--r--src/widgets/widgets/qlabel.cpp6
-rw-r--r--src/widgets/widgets/qlineedit_p.cpp6
-rw-r--r--src/widgets/widgets/qmainwindowlayout.cpp6
22 files changed, 138 insertions, 8 deletions
diff --git a/src/widgets/accessible/qaccessiblemenu.cpp b/src/widgets/accessible/qaccessiblemenu.cpp
index fd5f1efc7a0..2416110042a 100644
--- a/src/widgets/accessible/qaccessiblemenu.cpp
+++ b/src/widgets/accessible/qaccessiblemenu.cpp
@@ -146,6 +146,11 @@ int QAccessibleMenuBar::indexOfChild(const QAccessibleInterface *child) const
#endif // QT_CONFIG(menubar)
+/*!
+ \class QAccessibleMenuItem
+ \inmodule QtWidgets
+ \internal
+*/
QAccessibleMenuItem::QAccessibleMenuItem(QWidget *owner, QAction *action)
: m_action(action), m_owner(owner)
{
diff --git a/src/widgets/accessible/qaccessiblewidget.cpp b/src/widgets/accessible/qaccessiblewidget.cpp
index b4adae2e6e6..6fd86004fff 100644
--- a/src/widgets/accessible/qaccessiblewidget.cpp
+++ b/src/widgets/accessible/qaccessiblewidget.cpp
@@ -455,6 +455,11 @@ QAccessibleWidgetV2::QAccessibleWidgetV2(QWidget *object, QAccessible::Role role
{
}
+/*!
+ \class QAccessibleWidgetV2
+ \inmodule QtWidgets
+ \internal
+*/
QAccessibleWidgetV2::QAccessibleWidgetV2(QWidget *object, QAccessible::Role role)
: QAccessibleWidget(object, role)
{
diff --git a/src/widgets/accessible/rangecontrols.cpp b/src/widgets/accessible/rangecontrols.cpp
index 1f7b20833dd..969fb74c2c1 100644
--- a/src/widgets/accessible/rangecontrols.cpp
+++ b/src/widgets/accessible/rangecontrols.cpp
@@ -34,6 +34,12 @@ using namespace Qt::StringLiterals;
#if QT_CONFIG(accessibility)
#if QT_CONFIG(spinbox)
+
+/*!
+ \class QAccessibleAbstractSpinBox
+ \inmodule QtWidgets
+ \internal
+*/
QAccessibleAbstractSpinBox::QAccessibleAbstractSpinBox(QWidget *w)
: QAccessibleWidgetV2(w, QAccessible::SpinBox), lineEdit(nullptr)
{
@@ -242,6 +248,12 @@ QSpinBox *QAccessibleSpinBox::spinBox() const
// ================================== QAccessibleDoubleSpinBox ==================================
+
+/*!
+ \class QAccessibleDoubleSpinBox
+ \inmodule QtWidgets
+ \internal
+*/
QAccessibleDoubleSpinBox::QAccessibleDoubleSpinBox(QWidget *widget)
: QAccessibleAbstractSpinBox(widget)
{
diff --git a/src/widgets/dialogs/qfiledialog.cpp b/src/widgets/dialogs/qfiledialog.cpp
index 03a42e321d2..1f39dbfb516 100644
--- a/src/widgets/dialogs/qfiledialog.cpp
+++ b/src/widgets/dialogs/qfiledialog.cpp
@@ -4172,6 +4172,12 @@ QSize QFileDialogTreeView::sizeHint() const
}
/*!
+ \class QFileDialogLineEdit
+ \inmodule QtWidgets
+ \internal
+*/
+
+/*!
// FIXME: this is a hack to avoid propagating key press events
// to the dialog and from there to the "Ok" button
*/
diff --git a/src/widgets/dialogs/qsidebar.cpp b/src/widgets/dialogs/qsidebar.cpp
index a357d34f327..1ac2271fa8b 100644
--- a/src/widgets/dialogs/qsidebar.cpp
+++ b/src/widgets/dialogs/qsidebar.cpp
@@ -360,6 +360,11 @@ void QUrlModel::changed(const QString &path)
}
}
+/*!
+ \class QSidebar
+ \inmodule QtWidgets
+ \internal
+*/
QSidebar::QSidebar(QWidget *parent) : QListView(parent)
{
}
diff --git a/src/widgets/graphicsview/qgraphicsscene.cpp b/src/widgets/graphicsview/qgraphicsscene.cpp
index 0b7877b96a6..0fe8f5b97fd 100644
--- a/src/widgets/graphicsview/qgraphicsscene.cpp
+++ b/src/widgets/graphicsview/qgraphicsscene.cpp
@@ -1087,6 +1087,12 @@ void QGraphicsScenePrivate::enableMouseTrackingOnViews()
}
/*!
+ \class QGraphicsScenePrivate
+ \inmodule QtWidgets
+ \internal
+*/
+
+/*!
Returns all items for the screen position in \a event.
*/
QList<QGraphicsItem *> QGraphicsScenePrivate::itemsAtPosition(const QPoint &screenPos,
diff --git a/src/widgets/graphicsview/qgraphicsscenebsptreeindex.cpp b/src/widgets/graphicsview/qgraphicsscenebsptreeindex.cpp
index 5a8f76fe440..ddf91a99b4f 100644
--- a/src/widgets/graphicsview/qgraphicsscenebsptreeindex.cpp
+++ b/src/widgets/graphicsview/qgraphicsscenebsptreeindex.cpp
@@ -58,6 +58,10 @@ static inline int intmaxlog(int n)
}
/*!
+ \class QGraphicsSceneBspTreeIndexPrivate
+ \inmodule QtWidgets
+ \internal
+
Constructs a private scene bsp index.
*/
QGraphicsSceneBspTreeIndexPrivate::QGraphicsSceneBspTreeIndexPrivate(QGraphicsScene *scene)
diff --git a/src/widgets/graphicsview/qgraphicssceneindex.cpp b/src/widgets/graphicsview/qgraphicssceneindex.cpp
index c37f4dfa977..2f9dba99941 100644
--- a/src/widgets/graphicsview/qgraphicssceneindex.cpp
+++ b/src/widgets/graphicsview/qgraphicssceneindex.cpp
@@ -170,6 +170,10 @@ namespace QtPrivate { // just to keep indentation of the following functions at
} // namespace QtPrivate
/*!
+ \class QGraphicsSceneIndexPrivate
+ \inmodule QtWidgets
+ \internal
+
Constructs a private scene index.
*/
QGraphicsSceneIndexPrivate::QGraphicsSceneIndexPrivate(QGraphicsScene *scene) : scene(scene)
diff --git a/src/widgets/graphicsview/qgraphicsview.cpp b/src/widgets/graphicsview/qgraphicsview.cpp
index 657fc828074..2246ad6d39e 100644
--- a/src/widgets/graphicsview/qgraphicsview.cpp
+++ b/src/widgets/graphicsview/qgraphicsview.cpp
@@ -1119,6 +1119,12 @@ void QGraphicsViewPrivate::freeStyleOptionsArray(QStyleOptionGraphicsItem *array
Q_GUI_EXPORT extern QPainterPath qt_regionToPath(const QRegion &region);
/*!
+ \class QGraphicsViewPrivate
+ \inmodule QtWidgets
+ \internal
+*/
+
+/*!
### Adjustments in findItems: mapToScene(QRect) forces us to adjust the
input rectangle by (0, 0, 1, 1), because it uses QRect::bottomRight()
(etc) when mapping the rectangle to a polygon (which is _wrong_). In
diff --git a/src/widgets/itemviews/qcolumnviewgrip.cpp b/src/widgets/itemviews/qcolumnviewgrip.cpp
index fe82c450c2d..269955a8d63 100644
--- a/src/widgets/itemviews/qcolumnviewgrip.cpp
+++ b/src/widgets/itemviews/qcolumnviewgrip.cpp
@@ -13,19 +13,18 @@ QT_BEGIN_NAMESPACE
/*
\internal
- class QColumnViewGrip
-
- QColumnViewGrip is created to go inside QAbstractScrollArea's corner.
- When the mouse it moved it will resize the scroll area and emit's a signal.
- */
-
-/*
- \internal
\fn void QColumnViewGrip::gripMoved()
Signal that is emitted when the grip moves the parent widget.
*/
/*!
+ \class QColumnViewGrip
+ \inmodule QtWidgets
+ \internal
+
+ QColumnViewGrip is created to go inside QAbstractScrollArea's corner.
+ When the mouse is moved it will resize the scroll area and emit a signal.
+
Creates a new QColumnViewGrip with the given \a parent to view a model.
Use setModel() to set the model.
*/
diff --git a/src/widgets/itemviews/qlistview.cpp b/src/widgets/itemviews/qlistview.cpp
index ff1bec803d7..e245f98151b 100644
--- a/src/widgets/itemviews/qlistview.cpp
+++ b/src/widgets/itemviews/qlistview.cpp
@@ -608,6 +608,12 @@ void QListViewPrivate::selectAll(QItemSelectionModel::SelectionFlags command)
}
/*!
+ \class QListViewPrivate
+ \inmodule QtWidgets
+ \internal
+*/
+
+/*!
\reimp
We have a QListView way of knowing what elements are on the viewport
diff --git a/src/widgets/itemviews/qlistwidget.cpp b/src/widgets/itemviews/qlistwidget.cpp
index d175bf9c5a1..54279efe2f0 100644
--- a/src/widgets/itemviews/qlistwidget.cpp
+++ b/src/widgets/itemviews/qlistwidget.cpp
@@ -256,6 +256,12 @@ bool QListModel::removeRows(int row, int count, const QModelIndex &parent)
}
/*!
+ \class QListModel
+ \inmodule QtWidgets
+ \internal
+*/
+
+/*!
\since 5.13
\reimp
*/
diff --git a/src/widgets/itemviews/qtreeview.cpp b/src/widgets/itemviews/qtreeview.cpp
index 84ff04c9f34..e38d78b72f8 100644
--- a/src/widgets/itemviews/qtreeview.cpp
+++ b/src/widgets/itemviews/qtreeview.cpp
@@ -1453,6 +1453,12 @@ QRect QTreeViewPrivate::intersectedRect(const QRect rect, const QModelIndex &top
}
/*!
+ \class QTreeViewPrivate
+ \inmodule QtWidgets
+ \internal
+*/
+
+/*!
\reimp
We have a QTreeView way of knowing what elements are on the viewport
diff --git a/src/widgets/itemviews/qtreewidget.cpp b/src/widgets/itemviews/qtreewidget.cpp
index 6b03b6f9f1a..f8ffaba3ec2 100644
--- a/src/widgets/itemviews/qtreewidget.cpp
+++ b/src/widgets/itemviews/qtreewidget.cpp
@@ -523,6 +523,12 @@ bool QTreeModel::setHeaderData(int section, Qt::Orientation orientation,
}
/*!
+ \class QTreeModel
+ \inmodule QtWidgets
+ \internal
+*/
+
+/*!
\reimp
Returns the flags for the item referred to the given \a index.
diff --git a/src/widgets/kernel/qapplication.cpp b/src/widgets/kernel/qapplication.cpp
index fa95a1d2538..d2b0fb724ac 100644
--- a/src/widgets/kernel/qapplication.cpp
+++ b/src/widgets/kernel/qapplication.cpp
@@ -503,6 +503,12 @@ void qt_init_tooltip_palette()
extern void qRegisterWidgetsVariant();
/*!
+ \class QApplicationPrivate
+ \inmodule QtWidgets
+ \internal
+*/
+
+/*!
Initializes the QApplication object, called from the constructors.
*/
void QApplicationPrivate::initialize()
diff --git a/src/widgets/kernel/qlayout.cpp b/src/widgets/kernel/qlayout.cpp
index 5ba92714f6c..45b0c8d2aea 100644
--- a/src/widgets/kernel/qlayout.cpp
+++ b/src/widgets/kernel/qlayout.cpp
@@ -771,6 +771,12 @@ void QLayoutPrivate::reparentChildWidgets(QWidget *mw)
}
/*!
+ \class QLayoutPrivate
+ \inmodule QtWidgets
+ \internal
+*/
+
+/*!
Returns \c true if the \a widget can be added to the \a layout;
otherwise returns \c false.
*/
diff --git a/src/widgets/kernel/qwidgetrepaintmanager.cpp b/src/widgets/kernel/qwidgetrepaintmanager.cpp
index 93464264506..30526e38b3e 100644
--- a/src/widgets/kernel/qwidgetrepaintmanager.cpp
+++ b/src/widgets/kernel/qwidgetrepaintmanager.cpp
@@ -597,6 +597,12 @@ static QPlatformTextureList *widgetTexturesFor(QWidget *tlw, QWidget *widget)
// ---------------------------------------------------------------------------
/*!
+ \class QWidgetRepaintManager
+ \inmodule QtWidgets
+ \internal
+*/
+
+/*!
Synchronizes the \a exposedRegion of the \a exposedWidget with the backing store.
If there are dirty widgets, including but not limited to the \a exposedWidget,
@@ -1202,6 +1208,12 @@ bool QWidgetRepaintManager::isDirty() const
}
/*!
+ \class QWidgetPrivate
+ \inmodule QtWidgets
+ \internal
+*/
+
+/*!
Invalidates the backing store when the widget is resized.
Static areas are never invalidated unless absolutely needed.
*/
diff --git a/src/widgets/util/qflickgesture.cpp b/src/widgets/util/qflickgesture.cpp
index a05781cd439..41d02779039 100644
--- a/src/widgets/util/qflickgesture.cpp
+++ b/src/widgets/util/qflickgesture.cpp
@@ -293,6 +293,12 @@ QFlickGestureRecognizer::QFlickGestureRecognizer(Qt::MouseButton button)
this->button = button;
}
+/*!
+ \class QFlickGestureRecognizer
+ \inmodule QtWidgets
+ \internal
+*/
+
/*! \reimp
*/
QGesture *QFlickGestureRecognizer::create(QObject *target)
diff --git a/src/widgets/widgets/qcombobox.cpp b/src/widgets/widgets/qcombobox.cpp
index 1dcbec27487..0182ab8531f 100644
--- a/src/widgets/widgets/qcombobox.cpp
+++ b/src/widgets/widgets/qcombobox.cpp
@@ -829,6 +829,12 @@ QAbstractItemView *QComboBoxPrivateContainer::itemView() const
}
/*!
+ \class QComboBoxPrivateContainer
+ \inmodule QtWidgets
+ \internal
+*/
+
+/*!
Sets the item view to be used for the combobox popup.
*/
void QComboBoxPrivateContainer::setItemView(QAbstractItemView *itemView)
diff --git a/src/widgets/widgets/qlabel.cpp b/src/widgets/widgets/qlabel.cpp
index 784ce2c8d19..a2171eb3473 100644
--- a/src/widgets/widgets/qlabel.cpp
+++ b/src/widgets/widgets/qlabel.cpp
@@ -518,6 +518,12 @@ void QLabel::setMargin(int margin)
}
/*!
+ \class QLabelPrivate
+ \inmodule QtWidgets
+ \internal
+*/
+
+/*!
Returns the size that will be used if the width of the label is \a
w. If \a w is -1, the sizeHint() is returned. If \a w is 0 minimumSizeHint() is returned
*/
diff --git a/src/widgets/widgets/qlineedit_p.cpp b/src/widgets/widgets/qlineedit_p.cpp
index ee80cca649c..0a083beeb25 100644
--- a/src/widgets/widgets/qlineedit_p.cpp
+++ b/src/widgets/widgets/qlineedit_p.cpp
@@ -293,6 +293,12 @@ void QLineEditPrivate::resetInputMethod()
}
/*!
+ \class QLineEditPrivate
+ \inmodule QtWidgets
+ \internal
+*/
+
+/*!
This function is not intended as polymorphic usage. Just a shared code
fragment that calls QInputMethod::invokeAction for this
class.
diff --git a/src/widgets/widgets/qmainwindowlayout.cpp b/src/widgets/widgets/qmainwindowlayout.cpp
index 1708a53f163..cec25faef3e 100644
--- a/src/widgets/widgets/qmainwindowlayout.cpp
+++ b/src/widgets/widgets/qmainwindowlayout.cpp
@@ -1541,6 +1541,12 @@ void QMainWindowLayout::removeToolBar(QToolBar *toolbar)
}
/*!
+ \class QMainWindowLayout
+ \inmodule QtWidgets
+ \internal
+*/
+
+/*!
Adds \a toolbar to \a area, continuing the current line.
*/
void QMainWindowLayout::addToolBar(Qt::ToolBarArea area,