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 <volker.hilsheimer@qt.io>
This commit is contained in:
Axel Spoerl 2022-03-28 18:09:15 +02:00
parent 9ff40b59da
commit 87762234a7

View File

@ -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
*/
/*!