From 87762234a7de535935da29358a669d134266ae6a Mon Sep 17 00:00:00 2001 From: Axel Spoerl Date: Mon, 28 Mar 2022 18:09:15 +0200 Subject: [PATCH] Update documentation of enum Qt::DockWidgetArea Describe enum usage in QDockWidget::isAreaAllowed() as well as meaning of enum members. Pick-to: 6.3 6.2 5.15 Change-Id: Ib88509feb001be27c11fd167c9009da50ce1b851 Reviewed-by: Volker Hilsheimer --- src/corelib/global/qnamespace.qdoc | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/src/corelib/global/qnamespace.qdoc b/src/corelib/global/qnamespace.qdoc index 59a479d3d4..2bb93f4663 100644 --- a/src/corelib/global/qnamespace.qdoc +++ b/src/corelib/global/qnamespace.qdoc @@ -798,14 +798,18 @@ /*! \enum Qt::DockWidgetArea - \value LeftDockWidgetArea - \value RightDockWidgetArea - \value TopDockWidgetArea - \value BottomDockWidgetArea - \value AllDockWidgetAreas - \value NoDockWidgetArea + Represents the areas a QDockWidget can be plugged to. + \note A floating dock widget with tabs can be docked anywhere. + + \value LeftDockWidgetArea The left dock area of a QMainWindow. + \value RightDockWidgetArea The right dock area of a QMainWindow. + \value TopDockWidgetArea The top dock area of a QMainWindow. + \value BottomDockWidgetArea The bottom dock area of a QMainWindow. + \value AllDockWidgetAreas All dock widget areas (default). + \value NoDockWidgetArea No dock widget areas. \omitvalue DockWidgetArea_Mask + \sa QDockWidget::setAllowedAreas, QDockWidget::isAreaAllowed */ /*!