QDockWidget: fix documentation of the new dockLocation property

Follow the standard syntax for property documentation.

Amends cbd2f56c14159a1a566f4e423b910256724fdb6a.

Change-Id: I3557eba1990b684a35ab70f95e7f8ccf33850537
Reviewed-by: Axel Spoerl <axel.spoerl@qt.io>
(cherry picked from commit df96b28f65ad0ba1094c756929cfcdd9f19e4529)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
(cherry picked from commit c90130a72d17219842b6936a952ccd2e5b3a2a01)
This commit is contained in:
Volker Hilsheimer 2025-03-11 10:26:16 +01:00 committed by Qt Cherry-pick Bot
parent 4db483e83a
commit 4ad126219e

View File

@ -1857,13 +1857,13 @@ void QDockWidget::setTitleBarWidget(QWidget *widget)
/*!
\since 6.9
\brief QDockWidget::setDockLocation(): Assign dock widget to \a area.
If docked at another dock location, it will move to \a area.
If floating or part of floating tabs, the next call of setFloating(false)
will dock it at \a area.
\note
setDockLocation(Qt::NoDockLocation) is equivalent to setFloating(true).
Assigns this dock widget to \a area. If docked at another dock location, it
will move to \a area. If floating or part of floating tabs, the next call
of setFloating(false) will dock it at \a area.
\note setDockLocation(Qt::NoDockLocation) is equivalent to setFloating(true).
\sa dockLocation(), dockLocationChanged()
*/
void QDockWidget::setDockLocation(Qt::DockWidgetArea area)
@ -1879,11 +1879,11 @@ void QDockWidget::setDockLocation(Qt::DockWidgetArea area)
}
/*!
\property QDockWidget::dockLocation
\since 6.9
\brief QDockWidget::dockLocation()
\return the current dock location, or Qt::NoDockLocation if it's floating
and/or has no mainwindow parent.
\sa setDockLocation(), dockLocationChanged()
\brief the current dock location, or Qt::NoDockLocation if this dock widget
is floating or has no mainwindow parent.
*/
Qt::DockWidgetArea QDockWidget::dockLocation() const
{